Skip to content

FixYourDocs

Documentation for the FixYourDocs product — the open protocol, the SDKs, the CLI, the Hub, and the MCP server.

When an AI agent reads documentation and the docs are wrong, stale, or incomplete, the failure is usually silent — the agent guesses, retries, or gives up, and the maintainer never hears about it. FixYourDocs turns that silent failure into a structured signal: an agent (or a human) files a report against the exact doc page, and it lands as a GitHub Issue on the maintainer’s repo.

It works from both sides. If you maintain docs, you wire your repo so agents working in it offer to report your docs — with your OK — and you receive the Issues (Mode A). If you build with agents, you wire your own agent once, globally, so it offers — with your OK, on public docs only — to report the third-party docs it consults across every project (Mode B). Either way, the same report flows to whoever owns the doc.

This site documents every piece of the product. New here? The Getting started guide takes you from zero to a visible GitHub issue in under five minutes.

Python SDK

pip install fixyourdocs — build and send reports from Python. Python SDK →

TypeScript SDK

npm install @fixyourdocs/sdk — the same API for Node. TypeScript SDK →

CLI

npx @fixyourdocs/sdk init and npx @fixyourdocs/sdk report — no code required. CLI →

MCP server

One tool, file_doc_feedback, for Claude Desktop, Cursor, and Codex. MCP server →

The Hub

hub.fixyourdocs.io receives reports and forwards them to GitHub. The Hub →

  1. An agent reads some docs — yours, or a third-party library’s — and hits a problem.
  2. It files a v0 Docs Feedback Protocol report — via the SDK, the CLI, the MCP server, or the plain curl in the AGENTS.md snippet.
  3. The report is POSTed to the Hub at hub.fixyourdocs.io/v1/reports.
  4. If you’ve connected the Hub to your repo and verified you own the doc’s domain, the report appears as a GitHub Issue you can triage.

The protocol is open and the SDKs are Apache-2.0 — the Hub is one way to receive reports, not the only way.

Found something wrong, missing, or out of date on this page? File a docs-feedback report →