Ref Tools MCP

🚀 Ref MCP

Ref MCPは、ModelContextProtocolサーバーです。これを使用すると、AIコーディングツールやエージェントがAPI、サービス、ライブラリなどのドキュメントにアクセスできます。高速かつトークン効率の良い方法で、エージェントが最新のドキュメントを参照できるワンストップソリューションです。

詳細はref.toolsを参照してください。

🚀 クイックスタート

RefをMCPサーバーとしてセットアップするには、ストリーミング可能なHTTPサーバー（実験的）またはローカルのstdioサーバーの2つのオプションがあります。

このリポジトリには、レガシーのstdioサーバーが含まれています。

📦 インストール

stdio

"Ref": {
  "command": "npx",
  "args": ["ref-tools-mcp"],
  "env": {
    "REF_API_KEY": <APIキーを取得するにはサインアップしてください>
  }
}

Streamable HTTP (実験的)

"Ref": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote@0.1.0-0",
      "https://api.ref.tools/mcp",
      "--header",
      "x-ref-api-key:<APIキーを取得するにはサインアップしてください>"
    ]
  }
}

2025年4月現在、MCPはストリーミング可能なHTTPサーバーをサポートしています。Refはこれを実装していますが、すべてのクライアントがまだサポートしていないため、最も信頼性の高いアプローチはmcp-remoteをローカルプロキシとして使用することです。クライアントがストリーミング可能なHTTPサーバーをサポートしていることがわかっている場合は、直接https://api.ref.tools/mcpを使用しても構いません。

以前のアルファユーザーへの注意: REF_ALPHA設定は引き続きサポートされています。更新が必要な場合は通知されます。

💻 使用例

基本的な使用法

Ref MCPサーバーは、エージェントのニーズに合わせたすべてのドキュメント関連ツールを提供します。

ref_search_documentation

技術ドキュメントを調べるための強力な検索ツールです。技術的なプラットフォーム、フレームワーク、API、サービス、データベース、またはライブラリに関する情報が必要なときはいつでも、このツールを使用してください。関連するドキュメントを検索し、必要な情報をページの特定のセクションまで正確に見つけます。

ref_read_url

Webページの全内容を読み取るツールです。これにより、エージェントがドキュメントやWeb検索のリンクをたどることができます。

ref_search_web (オプション)

ref_search_documentationで必要な情報が見つからない場合のフォールバックWeb検索ツールです。Web上の関連ページへのリンクを見つけ、ref_read_urlツールを使用して関連するページを読むことができます。

このツールを含めることで、Refは1つのMCPサーバーですべての検索ニーズをカバーできます。ただし、別の検索プロバイダーを好む場合は、DISABLE_SEARCH_WEB環境変数をtrueに設定するか、ストリーミング可能なHTTPサーバーのdisable_search_web=falseURLパラメーターを設定することで、ref_search_webを無効にすることができます。

🔧 開発方法

インスペクターを使用した実行

開発およびデバッグ目的で、MCPインスペクターツールを使用できます。インスペクターは、MCPサーバーの相互作用をテストおよび監視するための視覚的なインターフェースを提供します。

詳細なセットアップ手順については、インスペクターのドキュメントを参照してください。

インスペクターでローカルテストするには、次のコマンドを実行します。

npm run inspect

または、ウォッチャーとインスペクターの両方を実行するには、次のコマンドを実行します。

npm run dev

ローカル開発

1. リポジトリをクローンします。
2. 依存関係をインストールします。

npm install

3. プロジェクトをビルドします。

npm run build

4. 自動再構築を伴う開発を行うには、次のコマンドを実行します。

npm run watch

📄 ライセンス

MITライセンスの下で公開されています。