关键词

Spryker包搜索代码搜索GitHub APIAI助手集成

项目简介

这是一个基于Model Context Protocol (MCP) 构建的命令行工具，旨在作为MCP服务器运行，为支持MCP协议的LLM客户端（如AI助手）提供搜索Spryker相关软件包及其代码内容的能力。它通过与GitHub API交互，响应来自LLM的搜索请求，并将结果格式化后返回。

主要功能点

  • 搜索Spryker包： 根据自然语言查询，搜索Spryker在GitHub上的相关代码仓库（视为“包”）。
  • 搜索代码内容： 在Spryker的GitHub仓库中搜索指定的PHP代码片段。
  • 组织过滤： 支持按指定的GitHub组织（如'spryker', 'spryker-eco', 'spryker-sdk', 'spryker-shop'）进行搜索过滤。
  • Stdio传输： 使用标准输入输出（stdio）作为与MCP客户端通信的协议。

安装步骤

  1. 确保您的系统已安装Node.js (包含npm和npx)。
  2. 克隆本项目仓库： 
    git clone https://github.com/vitaliiivanovspryker/spryker-package-search-mcp.git
  3. 进入项目目录并安装依赖： 
    cd spryker-package-search-mcp
npm install

服务器配置

本项目作为MCP服务器，需要由支持MCP协议的LLM客户端（如某些AI助手的设置界面）进行配置和启动。客户端需要知道如何运行此服务器。典型的配置涉及指定启动命令和参数。

您需要在LLM客户端的MCP服务器配置中，添加类似如下的条目：

  • 服务器名称 (Server Name): 可以自定义，例如 'sprykerPackageSearch'。
  • 命令 (Command): 启动MCP服务器的执行命令，通常是 'npx'。
  • 参数 (Args): 传递给命令的参数数组，用于指定运行哪个脚本。例如：'["-y", "/您的项目完整路径/spryker-package-search-mcp"]'。请将 '/您的项目完整路径/spryker-package-search-mcp' 替换为您实际克隆的项目目录的完整路径。
  • 环境变量 (Environment Variables): 可能需要设置 'GITHUB_PERSONAL_ACCESS_TOKEN'，值为您的GitHub个人访问令牌，以便进行API调用。这是为了避免API限流或访问私有仓库。

客户端会根据上述配置在需要时启动并连接到此MCP服务器。

基本使用方法

一旦在您的LLM客户端中正确配置并启动了此MCP服务器，AI助手即可通过它提供的工具来增强上下文。您可以通过自然语言向AI助手提问，例如：

  • “搜索Spryker核心代码库中的Package类。” (AI可能会调用 'search_spryker_package_code' 工具)
  • “查找spryker-eco组织下的所有checkout相关包。” (AI可能会调用 'search_spryker_packages' 工具)

AI助手会根据您的查询判断需要使用哪个工具，并自动将查询作为工具参数发送给MCP服务器。服务器执行搜索并将结果返回给AI助手，助手再将结果整合到其回复中。

信息

分类

开发者工具

访问项目