Devdocsmcp

🚀 DevDocsMCP

DevDocsMCP 是一款命令行工具，可讓你直接從 DevDocs.io 搜索和閱讀文檔。它完全在線運行，按需獲取數據。

🚀 快速開始

✨ 主要特性

• 可直接從 DevDocs.io 搜索和閱讀文檔。
• 支持作為 HTTP 服務器運行，通過 API 端點提供搜索和閱讀功能，便於與其他工具或服務集成。

📦 安裝指南

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

# 將其移動到 PATH 中的目錄（例如，/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。