UIThub MCP Server 使用说明

项目简介

UIThub MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，它充当 LLM 客户端（如 Claude）与 GitHub 之间的桥梁。通过集成 UIThub API，该服务器允许 LLM 客户端以标准化的方式访问 GitHub 仓库的内容，从而为 LLM 提供丰富的代码上下文信息，增强其代码理解和分析能力。

主要功能点

获取 GitHub 仓库内容: 提供工具让 LLM 能够检索指定 GitHub 仓库的文件和目录结构。
智能过滤选项: 支持多种参数，允许 LLM 精细控制需要获取的文件内容，例如：
- 指定包含或排除的文件扩展名 (ext, excludeExt)。
- 指定包含或排除的目录 (dir, excludeDir)。
- 限制最大文件大小 (maxFileSize) 和返回的 Token 数量 (maxTokens)。
- 可选择仅获取目录树结构 (omitFiles=true) 或同时获取文件内容。
Claude Desktop 集成: 专为 Claude Desktop 设计，通过 MCP 协议无缝集成，扩展 Claude 的代码理解能力。

安装步骤

安装 Node.js 和 npm: 确保您的系统已安装 Node.js 和 npm (Node Package Manager)。
执行初始化命令: 打开终端，运行以下命令以初始化并安装 UIThub MCP Server 到 Claude Desktop：
```
npx uithub-mcp init
```
此命令会自动配置 Claude Desktop 的 MCP 服务器设置。
重启 Claude Desktop: 完成初始化后，请重启 Claude Desktop 应用，使配置生效。

服务器配置

UIThub MCP Server 通过 'npx uithub-mcp init' 命令自动配置 Claude Desktop。以下是配置信息的示例，通常无需手动修改。

{
  "mcpServers": {
    "uithub": {
      "command": "node",
      "args": [
        "/path/to/uithub-mcp/index.js", //  指向 index.js 文件的路径，init 命令会自动配置，通常无需修改
        "run" //  运行服务器的命令参数
      ]
    }
  }
}

配置说明:

'"uithub"': 服务器名称，用于在 MCP 客户端中标识和调用。
'"command": "node"': 启动服务器的命令，这里使用 Node.js 解释器。
'"args"': 传递给 'node' 命令的参数列表：
- '"/path/to/uithub-mcp/index.js"': [重要] 'init' 命令会自动将此路径配置为 'uithub-mcp' 包的 'index.js' 文件，指向服务器的入口文件。用户通常不需要手动修改此路径。
- '"run"': 指定 'index.js' 以 "run" 模式启动服务器。

注意: 'init' 命令会自动处理路径配置，用户通常无需关心具体的路径设置。如果需要手动配置，请确保 '"args"' 中的第一个元素指向正确的 'index.js' 文件路径。

基本使用方法

安装并配置完成后，您可以在 Claude Desktop 中通过自然语言指令指示 Claude 使用 UIThub MCP Server 获取 GitHub 仓库内容。

例如，您可以向 Claude 提问：

"fetch code from repository janwilmake/uithub-mcp"
"get the file structure of repository openai/openai-python"
"analyze the code in the examples directory of tensorflow/tensorflow"

Claude 将会调用 UIThub MCP Server，根据您的指令从 GitHub 仓库获取相关代码信息，并用于生成回答或执行其他代码分析任务。

UIThub MCP Server