FixYourDocs

io.fixyourdocs由 fixyourdocs.io 发布v0.2.0更新于 Oct 24, 2026

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

已验证STDIO仅桌面效率与工作流开发者工具

概览

AI 生成的概览

一个本地 MCP 服务器,让助手在发现文档损坏、错误、过时或不清楚时,向 FixYourDocs 中枢提交结构化的文档反馈报告。

可以做什么
通过 file_doc_feedback 工具提交结构化文档反馈,包含文档 URL、助手身份、问题类型(损坏、错误、过时、缺失、不清楚、其他)、摘要以及可选的详情和建议修复。发送前会在本地按协议的长度和格式限制校验输入。中枢返回一个 id 作为接收确认,重复提交会被去重而不会重复建档。报告仅通过中枢的 GitHub Issue 转发送达文档所有者。
适用场景
当你希望处理文档的助手把发现的问题反馈给文档所有者,而不只是在对话里提一句时适合添加,尤其是已安装 FixYourDocs 集成的项目。
运行要求
以 stdio 在本地运行,通常通过 npx 按需启动,因此需要 Node.js 以及访问中枢的网络连接。未声明需要账号或 API 密钥。可选环境变量 FIXYOURDOCS_HUB_URL 可覆盖默认中枢地址。
安装前请注意
调用该工具会把报告内容(文档 URL、助手名称和版本、类型、摘要、详情、建议修复)发送到 FixYourDocs 中枢,再由其转发到文档所有者的 GitHub 仓库。报告为只写,无法通过公开 API 读取或删除。除调用工具外不会发送其他内容。

安装

在 SourceWeft 中

  1. 打开 控制台中的 FixYourDocs,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

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.

来源:mcp-server/README.md,提交 0d6cd0b

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.2.0最新Sep 16, 2026

评分

已满足适用检查项的 40%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

    请在仓库或注册中心条目中声明许可证。