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>：文档的 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>：文档的 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：可选。此服务实例应提供的语言 slug 列表，以逗号分隔（例如，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。