
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.
概覽
一個本機 MCP 伺服器,讓助理在發現文件損壞、錯誤、過時或不清楚時,向 FixYourDocs 中樞提交結構化的文件回饋報告。
- 可以做什麼
- 透過 file_doc_feedback 工具提交結構化文件回饋,包含文件 URL、助理身分、問題類型(損壞、錯誤、過時、缺漏、不清楚、其他)、摘要以及選填的詳細說明與建議修正。送出前會在本機依協定的長度與格式限制驗證輸入。中樞會回傳一個 id 作為收件確認,重複提交會被去重而不會重複建檔。報告僅透過中樞的 GitHub Issue 轉送給文件擁有者。
- 適用情境
- 當你希望處理文件的助理把發現的問題回饋給文件擁有者,而不只是在對話中提一句時適合加入,尤其是已安裝 FixYourDocs 整合的專案。
- 執行需求
- 以 stdio 在本機執行,通常透過 npx 隨需啟動,因此需要 Node.js 以及連線到中樞的網路。未宣告需要帳號或 API 金鑰。選用環境變數 FIXYOURDOCS_HUB_URL 可覆寫預設中樞位址。
安裝
在 SourceWeft 中
- 開啟 儀表板中的 FixYourDocs,將其新增到工作區。
- 為需要使用其工具的對話啟用該服務。
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.
- Docs: docs.fixyourdocs.io/mcp/
- Spec: Docs Feedback Protocol v0
- SDK:
@fixyourdocs/sdk - Issues / contributions: https://github.com/fixyourdocs/fixyourdocs
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:
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):
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):
Codex / OpenAI Codex CLI
Edit ~/.codex/config.toml:
mcp-inspector (for verification)
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:
Output
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: trueresults with a human-readable explanation. - On a
201 Created(new submission) or200 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
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版本歷史
1- v0.2.0最新Sep 16, 2026
評分
已滿足適用檢查項的 40%
該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。
- 近 30 天內可連通25 分
請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。
- 已宣告認證方式10 分
請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。
- 已列出工具15 分
請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。
- 描述必需15 分
- 圖示10 分
- 文件15 分
- 授權條款10 分
請在儲存庫或註冊中心條目中宣告授權條款。