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

# Download the binary (replace [OS] and [ARCH] with your system, e.g., linux_amd64, darwin_arm64)
wget https://github.com/kelvinzer0/DevDocsMCP/releases/download/[VERSION]/devdocsmcp_[OS]_[ARCH] -O devdocsmcp

# Make it executable
chmod +x devdocsmcp

# Move it to a directory in your PATH (e.g., /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 に追加します。