Devdocsmcp

🚀 DevDocsMCP

DevDocsMCPは、DevDocs.io から直接ドキュメントを検索して読むことができるコマンドラインツールです。このツールは純粋にオンラインで動作し、必要に応じてデータを取得します。

🚀 クイックスタート

📦 インストール

1. Goのインストール: システムにGoがインストールされていることを確認してください。golang.org からダウンロードできます。
2. リポジトリのクローン:

   git clone https://github.com/kelvinzer0/DevDocsMCP.git
   cd DevDocsMCP
   

3. アプリケーションのビルド:

   go build -o devdocsmcp cmd/devdocsmcp/main.go
   

   これにより、現在のディレクトリに devdocsmcp という実行ファイルが作成されます。

💻 使用例

基本的な使用法

ターミナルで DevDocsMCP ディレクトリに移動します。

ドキュメントの検索

特定のドキュメントセット内で用語を検索するには、次のコマンドを使用します。

./devdocsmcp search -lang <language_slug> -query <search_query>

• <language_slug>: ドキュメントのスラッグ (例: html, css, angularjs~1.8, vite, tailwindcss, go, mysql, sqlite)。利用可能なドキュメントのリストは DevDocs.io で確認できます。
• <search_query>: 検索したい用語。

例:

• HTMLドキュメントで "display" を検索する場合:

  ./devdocsmcp search -lang html -query display
  

• AngularJS 1.8ドキュメントで "foreach" を検索する場合:

  ./devdocsmcp search -lang angularjs~1.8 -query foreach
  

ドキュメント内容の閲覧

特定のドキュメントエントリの内容を読むには、次のコマンドを使用します。

./devdocsmcp read -lang <language_slug> -path <entry_path>

• <language_slug>: ドキュメントのスラッグ (例: html, css, angularjs~1.8)。
• <entry_path>: 検索結果に表示される特定のドキュメントエントリへのパス (例: reference/elements/a, api/ng/function/angular.foreach)。

例:

• HTMLの <a> 要素のドキュメントを読む場合:

  ./devdocsmcp read -lang html -path reference/elements/a
  

• angular.forEach のドキュメントを読む場合:

  ./devdocsmcp read -lang angularjs~1.8 -path api/ng/function/angular.foreach
  

高度な使用法

MCPサーバーとして実行

DevDocsMCP はHTTPサーバーとしても実行でき、APIエンドポイントを介して検索および読み取り機能を公開します。これは、他のツールやサービスと統合する場合に便利です。

サーバーを起動するには、次のコマンドを使用します。

./devdocsmcp server [-port <port_number>] -lang <comma_separated_languages>

• -port: オプション。サーバーがリッスンするポート番号。デフォルトは 8080 です。
• -lang: オプション。このサーバーインスタンスが提供する言語スラッグのカンマ区切りのリスト (例: html,css)。指定しない場合、すべての言語が許可されます。

MCPサーバーの設定例: DevDocsMCP をMCPサーバーとして設定するには、MCP設定ファイルに次のようなセクションを追加できます。

{
  "mcpServers": {
    "devdocs-html": {
        "command": "/path/to/your/DevDocsMCP/cmd/devdocsmcp",
        "args":["server", "--lang", "html"]
    },
    "devdocs-css": {
        "command": "/path/to/your/DevDocsMCP/cmd/devdocsmcp",
        "args":["server", "--lang", "css"]
    },
    "devdocs-vite": {
        "command": "/path/to/your/DevDocsMCP/cmd/devdocsmcp",
        "args":["server", "--lang", "vite"]
    },
    "devdocs-tailwindcss": {
        "command": "/path/to/your/DevDocsMCP/cmd/devdocsmcp",
        "args":["server", "--lang", "tailwindcss"]
    },
    "devdocs-go": {
        "command": "/path/to/your/DevDocsMCP/cmd/devdocsmcp",
        "args":["server", "--lang", "go"]
    },
    "devdocs-mysql": {
        "command": "/path/to/your/DevDocsMCP/cmd/devdocsmcp",
        "args":["server", "--lang", "mysql"]
    },
    "devdocs-sqlite": {
        "command": "/path/to/your/DevDocsMCP/cmd/devdocsmcp",
        "args":["server", "--lang", "sqlite"]
    }
  }
}

注意: /path/to/your/DevDocsMCP/cmd/devdocsmcp を実際の devdocsmcp 実行ファイルの絶対パスに置き換えてください。キー "devdocs-html-css" は、このサーバーの一意の識別子であれば任意の名前を使用できます。

許可された言語の表示

devdocsmcp サーバーが許可するように設定された言語を表示するには、次のコマンドを使用します。

./devdocsmcp allowed-langs

このコマンドは、サーバーを起動する際に -lang フラグで指定された言語を表示します。言語が指定されていない場合、すべての言語が許可されていることを示します。

事前ビルド済みバイナリのダウンロード

様々なオペレーティングシステムとアーキテクチャ用の事前ビルド済みバイナリは、GitHub Releasesページから直接ダウンロードできます。

[VERSION] を目的のリリースバージョン (例: v1.0.0) に置き換えてください。

Linux / macOS

# バイナリをダウンロードする ( [OS] と [ARCH] をシステムに合わせて置き換える, 例: linux_amd64, darwin_arm64)
wget https://github.com/kelvinzer0/DevDocsMCP/releases/download/[VERSION]/devdocsmcp_[OS]_[ARCH] -O devdocsmcp

# 実行可能にする
chmod +x devdocsmcp

# パスの通ったディレクトリに移動する (例: /usr/local/bin)
sudo mv devdocsmcp /usr/local/bin/

Windows

GitHub Releasesページから適切な .exe ファイル (例: devdocsmcp_windows_amd64.exe) をダウンロードします。 ダウンロードしたファイルを devdocsmcp.exe にリネームします。 devdocsmcp.exe をシステムの PATH 環境変数に含まれるディレクトリに移動します。一般的な方法は、ユーザーディレクトリに bin フォルダ (例: C:\Users\YourUser\bin) を作成し、それを PATH に追加することです。