mcpField
F
FixYourDocs

FixYourDocs

ローカル
fixyourdocs.io開発ツール018 週間前に更新

FixYourDocs について

FixYourDocsは、壊れた文書、誤り、古い情報、欠落、不明瞭な記述について構造化レポートを送るMCPサーバーです。レポートはFixYourDocs hubに送られ、文書の所有者が連携機能を導入している場合はGitHub Issueに転送されます。

主な機能

  1. 01構造化された文書フィードバックの送信
  2. 02送信前のレポート項目の検証
  3. 03重複送信の排除
  4. 04hub URLの変更
  5. 05テレメトリーやバックグラウンド通信なし

活用シーン

  1. 01古い文書ページの報告
  2. 02不明瞭な説明への修正提案
  3. 03不足している文書のフィードバック

MCP 対応

stdioを介してMCPクライアントに`file_doc_feedback`ツールを提供します。呼び出すとFixYourDocs hubへレポートを送信し、条件に応じてGitHub Issueに転送されます。

設定

ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。

mcp.json · 共通設定
{
"mcpServers": {
"io-fixyourdocs": {
"command": "npx",
"args": [
"-y",
"@fixyourdocs/mcp-server"
],
"env": {
"FIXYOURDOCS_HUB_URL": "<FIXYOURDOCS_HUB_URL>"
}
}
}
}
起動コマンドnpx -y @fixyourdocs/mcp-server
設定が必要な環境変数
FIXYOURDOCS_HUB_URLOverride the hub base URL. Defaults to https://hub.fixyourdocs.io.

ローカルサーバーにはマシン上の実行環境(Node.js 18 以上など)が必要です。設定ファイルの場所はクライアントごとに異なります。

パッケージ
npm@fixyourdocs/mcp-server0.2.0

ツール

1

掲載時のツール一覧 · 2 週間前に更新

パラメーター型必須説明
agentobjectはいレポートを提出するエージェントの識別情報。
agent.namestringはい小文字の kebab-case エージェント識別子。例:"claude-code"、"cursor"、"codex"。 /^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/ に一致します。
agent.vendorstringいいえベンダー/発行元(任意)。例:"Anthropic"。
agent.versionstringいいえエージェントのバージョン文字列(任意)。例:"0.6.2"。
reportobjectはいレポート本文。
report.kindenumはい6 種類の v0 レポート形式のいずれか。broken | incorrect | outdated | missing | unclear | other
report.detailsstringいいえ任意の詳細な説明。期待される結果と実際の結果を示すのが理想です。
report.summarystringはい問題を1行で説明してください(≤ 280文字)。
report.suggested_fixstringいいえ任意の具体的なドキュメント修正案。
doc_urlstringはい問題の原因となったドキュメントページの URL(HTTPS、≤ 2048文字)。

詳細

@fixyourdocs/mcp-server

単一のツール、file_doc_feedback を提供する Model Context Protocol(MCP)サーバーです。MCP クライアント(Claude Desktop、Cursor、Codex、Gemini CLI、…)は、壊れている、誤っている、古くなっている、欠けている、不明瞭である、またはその他の理由で役に立たないドキュメントに遭遇した際、構造化されたドキュメントフィードバックレポートを FixYourDocs ハブ(hub.fixyourdocs.io)に送信できます。

ドキュメント所有者が FixYourDocs インテグレーションをインストールしている場合、レポートはそのリポジトリの GitHub Issue に転送されます。ホームへの通信やテレメトリーはありません。エージェントが明示的にツールを呼び出した場合にのみ、サーバーはハブに接続します。

インストール

このサーバーは npx 経由で実行するように設計されているため、通常は直接インストールする必要はありません。MCP クライアントが必要に応じて起動します。

npx -y @fixyourdocs/mcp-server

標準の MCP stdio トランスポートを使用します。別のハブを指定する場合を除き、設定は不要です(下記の環境変数を参照)。

クライアントの設定

MCP クライアントごとに独自の設定ファイルがありますが、形式は同じです。command と args を指定した名前付きサーバーエントリを記述します。

Claude Desktop

~/Library/Application Support/Claude/claude_desktop_config.json(macOS)または %APPDATA%\Claude\claude_desktop_config.json(Windows)を編集します。

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

Claude Desktop を再起動します。ツール一覧に file_doc_feedback が表示されます。

Cursor

~/.cursor/mcp.json(またはワークスペースの .cursor/mcp.json)を編集します。

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

~/.codex/config.toml を編集します。

[mcp_servers.fixyourdocs]
command = "npx"
args = ["-y", "@fixyourdocs/mcp-server"]
mcp-inspector(動作確認用)
npx @modelcontextprotocol/inspector npx -y @fixyourdocs/mcp-server

インスペクターの UI には file_doc_feedback が表示されます。サンプルレポートを入力すると、ハブから返される { id } が表示されます。

ツール:file_doc_feedback

入力

v0 仕様の Report エンベロープに準拠しています。

フィールド型必須備考
doc_urlstringはい問題が発生したドキュメントページの URL。最大 2048 文字です。
agent.namestringはい小文字のケバブケース形式の識別子。例:claude-code、cursor、codex。最大 64 文字です。
agent.versionstringいいえ任意のエージェントバージョン文字列です。
agent.vendorstringいいえ任意のベンダー/パブリッシャー名。例:Anthropic。
report.kindenumはい次のいずれかです:broken、incorrect、outdated、missing、unclear、other。
report.summarystringはい1 行の説明です。280 文字以下です。
report.detailsstringいいえ任意の詳細な説明です。8000 文字以下です。
report.suggested_fixstringいいえ任意の具体的な提案です。4000 文字以下です。
出力
{
  "id": "01ABCDEF0123456789ABCDEFGH"
}

id はハブから返される ULID です。これは冪等性の確認に使うものであり、取得可能なハンドルではありません。公開 API ではレポートは書き込み専用です。取得用のエンドポイントはなく、レポートの内容がドキュメント所有者に届くのは、ハブによる GitHub Issue への転送を通じてのみです。

動作
  • サーバーはハブに接続する前に、入力が v0 の字句制約 (URL の解析、エージェント名のパターン、概要の長さ)に準拠しているかを検証します。検証エラーは、人が読める説明を含む MCP の isError: true 結果として返されます。
  • 201 Created(新規送信)または 200 OK(冪等な重複)の場合、ツールはどちらの場合も { id } を返します。エージェントが区別する必要はありません。ハブが課題を二重登録することはありません。
  • 429 rate_limited、5xx、またはネットワークエラーが発生した場合、ツールはエラーをそのまま表示します。クライアントは一時的なエラーとして扱い、同じペイロードで再試行してください(ハブは本文の内容に基づいて重複を排除します)。

環境変数

変数デフォルト用途
FIXYOURDOCS_HUB_URLhttps://hub.fixyourdocs.ioハブのベース URL を上書きします。テストやセルフホストに便利です。

プライバシー

  • テレメトリなし、外部への自動通信なし。 サーバーが外部ネットワークに 接続するのは、エージェントが明示的にツールを呼び出した場合 のみです。分析情報の送信、バージョン確認の ping、診断情報の アップロードは行いません。
  • 報告ペイロードに含まれるのは、エージェントが指定したフィールド (ドキュメント URL、エージェントの識別情報、種類、概要、任意の詳細と 修正案)のみです。プロセス環境、ファイルパス、システム識別子は追加されません。

ライセンス

Apache-2.0。詳細は LICENSE を参照してください。

コメント

MCP は初めてですか?

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。