使用说明

项目简介

本项目 'MCP GitHub Trending Server' 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为大型语言模型(LLM)提供访问 GitHub 趋势仓库和开发者数据的能力。通过简单的工具调用,LLM 可以获取实时的 GitHub 技术趋势信息,从而增强其在软件开发、技术研究等领域的应用能力。

主要功能点

  • 获取 GitHub 趋势仓库数据: 允许 LLM 查询 GitHub 上当前流行的仓库信息,可以根据编程语言、时间周期和口语进行筛选。
  • 获取 GitHub 趋势开发者数据: 允许 LLM 查询 GitHub 上当前活跃的开发者信息,可以根据编程语言和时间周期进行筛选。
  • 数据过滤: 支持多种参数过滤,如编程语言、时间周期(日、周、月)和口语,以满足不同的信息需求。
  • JSON 格式响应: 返回结构化的 JSON 数据,方便 LLM 解析和利用。

安装步骤

  1. 环境准备: 确保已安装 Python 3.12 或更高版本。
  2. 安装软件包: 打开终端或命令提示符,运行以下命令安装 'mcp-github-trending' 包:
    pip install mcp-github-trending

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以下是针对 Claude Desktop 客户端的配置示例。您需要根据您的 MCP 客户端类型进行相应的配置。

Claude Desktop 配置示例 (JSON 格式):

请根据您希望的部署方式选择 "Development/Unpublished Servers Configuration" 或 "Published Servers Configuration" 其中一种进行配置。

开发/未发布服务器配置 (Development/Unpublished Servers Configuration):

{
  "mcpServers": {
    "mcp-github-trending": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/mcp-github-trending",  //  请替换为 mcp-github-trending 包的安装路径,例如:/Users/your_username/.local/lib/python3.12/site-packages/mcp_github_trending
        "run",
        "mcp-github-trending"
      ]
    }
  }
}
  • 'command': 指定启动服务器的命令,这里使用 'uv',通常用于运行 Python 项目。
  • 'args': 命令参数列表。
    • '--directory': 指定服务器代码所在的目录。需要用户根据实际安装路径进行替换
    • 'run mcp-github-trending': 运行 'mcp-github-trending' 模块,启动服务器。

已发布服务器配置 (Published Servers Configuration):

{
  "mcpServers": {
    "mcp-github-trending": {
      "command": "uvx",
      "args": [
        "mcp-github-trending" //  直接运行已发布的 mcp-github-trending 包
      ]
    }
  }
}
  • 'command': 指定启动已发布服务器的命令,这里使用 'uvx',用于运行已发布的 Python 包。
  • 'args': 命令参数列表。
    • 'mcp-github-trending': 指定要运行的已发布包名称。

配置说明:

  1. 找到 Claude Desktop 的配置文件 'claude_desktop_config.json',根据您的操作系统,文件路径可能为:
    • MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%/Claude/claude_desktop_config.json'
  2. 打开 'claude_desktop_config.json' 文件,将上述 开发/未发布服务器配置已发布服务器配置 JSON 代码片段添加到 'mcpServers' 字段中。如果 'mcpServers' 字段不存在,请创建它。
  3. 保存 'claude_desktop_config.json' 文件。
  4. 重启 Claude Desktop 或 MCP 客户端,配置即可生效。

基本使用方法

配置完成后,您的 MCP 客户端(如 Claude Desktop)应该能够检测到 'mcp-github-trending' 服务器提供的工具。

LLM 可以通过调用以下工具来获取 GitHub 趋势数据:

  1. 'get_github_trending_repositories': 获取趋势仓库数据。

    • 可选参数:
      • 'language' (string): 编程语言 (例如: "python", "javascript")。
      • 'since' (string): 时间周期 ("daily", "weekly", "monthly", 默认 "daily")。
      • 'spoken_language' (string): 口语。
    • 返回结果: 包含仓库信息的 JSON 数组。
  2. 'get_github_trending_developers': 获取趋势开发者数据。

    • 可选参数:
      • 'language' (string): 编程语言 (例如: "python", "javascript")。
      • 'since' (string): 时间周期 ("daily", "weekly", "monthly", 默认 "daily")。
    • 返回结果: 包含开发者信息的 JSON 数组。

LLM 可以根据需要选择合适的工具并提供相应的参数来查询 GitHub 趋势数据,并将返回的 JSON 数据用于后续的分析或生成任务。

信息

分类

网页与API