使用说明

项目简介

OpenDigger MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器，旨在为大型语言模型 (LLM) 提供访问 OpenDigger 数据的能力。通过此服务器，LLM 可以调用预设的工具来获取 OpenDigger 平台上的开源项目和用户的各种指标数据，从而增强 LLM 在软件开发、开源社区分析等领域的应用能力。

主要功能点

提供 OpenDigger 数据访问工具: 服务器内置 'get_open_digger_metric' 工具，允许 LLM 查询 OpenDigger 平台上的项目和用户指标数据，例如 OpenRank、社区 OpenRank 和活跃度等。
支持 GitHub 和 Gitee 平台: 工具支持查询 GitHub 和 Gitee 平台上的数据。
返回 JSON 格式数据: 工具返回的数据以 JSON 格式呈现，方便 LLM 理解和处理。

安装步骤

克隆仓库

git clone https://github.com/X-lab2017/open-digger-mcp-server.git
cd open-digger-mcp-server

安装依赖 确保已安装 Node.js 和 npm，然后运行：
```
npm install
```
构建项目
```
npm run build
```
启动服务器
```
npm start
```
服务器将在标准输入/输出 (stdio) 上运行，并输出日志信息 "OpenDigger MCP Server running on stdio"。

服务器配置

对于 MCP 客户端，您需要配置连接到 OpenDigger MCP Server 的信息。以下是一个 JSON 格式的配置示例，您需要将其添加到您的 MCP 客户端配置中：

{
  "serverName": "open-digger-mcp-server",  // MCP 服务器的名称，用于客户端识别
  "command": "node",                      // 启动 MCP 服务器的命令，这里使用 Node.js 运行
  "args": ["dist/index.js"]               // 启动命令的参数，指向编译后的服务器入口文件
}

配置说明:

'serverName': 服务器名称，设置为 "open-digger-mcp-server"。
'command': 运行服务器的命令，由于服务器是 Node.js 应用，所以设置为 "node"。
'args': 命令参数，指向编译后的 JavaScript 入口文件 'dist/index.js'。

基本使用方法

配置完成后，您的 MCP 客户端（例如 LLM 应用）可以通过以下步骤使用 OpenDigger MCP Server：

发现工具: 客户端向服务器发送 'ListToolsRequest' 请求，服务器会返回包含 'get_open_digger_metric' 工具的工具列表。
调用工具: 客户端使用 'CallToolRequest' 请求调用 'get_open_digger_metric' 工具，并提供以下参数：
- 'platform': 平台名称，可选值为 "GitHub" 或 "Gitee"。
- 'entityType': 实体类型，可选值为 "Repo"（仓库）或 "User"（用户）。
- 'owner' (当 'entityType' 为 "Repo" 时可选): 仓库所有者用户名。
- 'repo' (当 'entityType' 为 "Repo" 时可选): 仓库名称。
- 'login' (当 'entityType' 为 "User" 时可选): 用户登录名。
- 'metricName': 指标名称，可选值为 "openrank"、"community_openrank" 或 "activity"。
例如，要获取 GitHub 上 'X-lab2017/open-digger' 仓库的 'openrank' 指标数据，客户端需要构造包含参数 '{ platform: "GitHub", entityType: "Repo", owner: "X-lab2017", repo: "open-digger", metricName: "openrank" }' 的 'CallToolRequest'。
获取结果: 服务器会调用 OpenDigger API 获取数据，并将 JSON 格式的结果通过 'CallToolResponse' 返回给客户端。客户端可以解析 JSON 数据并在 LLM 应用中使用。

关键词