FixYourDocs

io.fixyourdocsPublished by fixyourdocs.iov0.2.0Updated Oct 24, 2026

File structured docs-feedback reports to the FixYourDocs hub via a file_doc_feedback tool.

Overview

AI-generated overview

A local MCP server that lets an assistant file a structured documentation-feedback report to the FixYourDocs hub when it finds docs broken, wrong, outdated orun

What you can do
File a structured docs-feedback report with the file_doc_feedback tool, giving the doc URL, agent identity, a kind (broken, incorrect, outdated, missing, unclear, other), a summary and optional details or suggested fix. Input is validated locally against the protocol's length and format limits before anything is sent. The hub returns an id confirming receipt; duplicate submissions are deduplicated rather than filed twice. Reports reach the doc owner only through the hub's GitHub-issue forwarding.
When to use it
Worth adding when you want an assistant working with documentation to report problems back to the doc owner instead of only mentioning them in chat, especially for projects that have a FixYourDocs integration installed.
Requirements
Runs locally over stdio, normally launched on demand with npx, so Node.js and network access to the hub are needed. No account or API key is declared. The optional FIXYOURDOCS_HUB_URL variable overrides the default hub address.
Before you install
Calling the tool sends the report contents (doc URL, agent name and version, kind, summary, details, suggested fix) to the FixYourDocs hub, which forwards them to the doc owner's GitHub repository. Reports are write-only and cannot be retrieved or deleted through the public API. Nothing else is sent unless the tool is invoked.

Installation

In SourceWeft

  1. Open FixYourDocs in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

@fixyourdocs/mcp-server

Model Context Protocol (MCP) server that exposes a single tool — file_doc_feedback — so any MCP client (Claude Desktop, Cursor, Codex, Gemini CLI, …) can file a structured documentation-feedback report to the FixYourDocs hub at hub.fixyourdocs.io when it encounters docs that are broken, incorrect, outdated, missing, unclear, or otherwise unhelpful.

Reports are forwarded to a GitHub Issue on the doc owner's repository when they have a FixYourDocs integration installed. No phone-home, no telemetry — the server only contacts the hub when an agent explicitly calls the tool.

Install

The server is designed to be run via npx, so you typically don't install it directly — your MCP client launches it on demand:

sh
npx -y @fixyourdocs/mcp-server

It speaks the standard MCP stdio transport. There is nothing to configure unless you want to point at a different hub (see Environment variables below).

Client configuration

Each MCP client has its own config file, but the shape is the same: a named server entry with command + args.

Claude Desktop

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

jsonc
{  "mcpServers": {    "fixyourdocs": {      "command": "npx",      "args": ["-y", "@fixyourdocs/mcp-server"]    }  }}

Restart Claude Desktop. The file_doc_feedback tool should appear in the tool list.

Cursor

Edit ~/.cursor/mcp.json (or your workspace's .cursor/mcp.json):

jsonc
{  "mcpServers": {    "fixyourdocs": {      "command": "npx",      "args": ["-y", "@fixyourdocs/mcp-server"]    }  }}

Codex / OpenAI Codex CLI

Edit ~/.codex/config.toml:

toml
[mcp_servers.fixyourdocs]command = "npx"args = ["-y", "@fixyourdocs/mcp-server"]

mcp-inspector (for verification)

sh
npx @modelcontextprotocol/inspector npx -y @fixyourdocs/mcp-server

The inspector UI lists file_doc_feedback, accepts a fixture report, and shows the { id } returned by the hub.

Tool: file_doc_feedback

Input

Mirrors the v0 spec's Report envelope:

FieldTypeRequiredNotes
doc_urlstringyesURL of the doc page that produced the problem. Max 2048 chars.
agent.namestringyesLowercase kebab-case identifier, e.g. claude-code, cursor, codex. Max 64 chars.
agent.versionstringnoOptional agent version string.
agent.vendorstringnoOptional vendor / publisher, e.g. Anthropic.
report.kindenumyesOne of: broken, incorrect, outdated, missing, unclear, other.
report.summarystringyesOne-line description, ≤ 280 chars.
report.detailsstringnoOptional longer description. ≤ 8000 chars.
report.suggested_fixstringnoOptional concrete suggestion. ≤ 4000 chars.

Output

jsonc
{  "id": "01ABCDEF0123456789ABCDEFGH"}

id is a ULID returned by the hub — an idempotency confirmation, not a fetchable handle. Reports are write-only on the public API: there is no retrieval endpoint, and report contents reach the doc owner only via the hub's GitHub-issue forwarding.

Behaviour

  • The server validates the input against the v0 lexical constraints (URL parsing, agent-name pattern, summary length) before contacting the hub. Validation errors are returned as MCP isError: true results with a human-readable explanation.
  • On a 201 Created (new submission) or 200 OK (idempotent duplicate), the tool returns { id } regardless — agents don't need to distinguish, the hub will not double-file the issue.
  • On 429 rate_limited, 5xx, or any network error, the tool surfaces the error verbatim. Clients should treat this as transient and retry with the same payload (the hub deduplicates on body content).

Environment variables

VariableDefaultPurpose
FIXYOURDOCS_HUB_URLhttps://hub.fixyourdocs.ioOverride the hub base URL. Useful for tests / self-host.

Privacy

  • No telemetry, no phone-home. The server makes outbound network calls only when an agent explicitly invokes the tool. There is no analytics call, no version-check ping, no diagnostic upload.
  • The report payload contains only the fields the agent supplies (doc URL, agent identity, kind, summary, optional details and suggested fix). No process environment, file paths, or system identifiers are appended.

License

Apache-2.0. See LICENSE.

Source: mcp-server/README.md at commit 0d6cd0b

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v0.2.0LatestSep 16, 2026

Score

40% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts

    Declare a license in the repository or the registry entry.