项目简介

这是一个基于Node.js实现的模型上下文协议(MCP)服务器。它使用官方的 '@modelcontextprotocol/sdk' 构建,旨在为AI助手(如Claude)提供结构化、可扩展的上下文和功能。服务器通过标准输入/输出(stdio)进行通信,方便与集成开发环境(如VS Code的MCP扩展)进行交互。该项目提供了一个模块化的基础框架,用户可以轻松地在此基础上添加自定义工具、管理资源和定义Prompt模板,以增强AI在特定领域的辅助能力。

主要功能点

  • 模块化设计: 将工具、资源和Prompt的实现分离到不同的模块中,便于管理和扩展。
  • Stdio通信: 通过标准输入输出通道进行通信,原生支持与VS Code等兼容MCP的客户端集成。
  • 基于TypeScript: 使用TypeScript编写,提供类型安全和更好的开发体验。
  • 易于扩展: 提供明确的接口和结构,方便开发者添加新的工具和能力。
  • 环境配置: 支持使用 '.env' 文件管理服务器运行时的环境变量。

安装步骤

要运行此MCP服务器,您需要先安装 Node.js 和 pnpm。

  1. 克隆仓库:
    git clone https://github.com/johnleider/mcp.git
  2. 进入仓库目录:
    cd mcp
  3. 安装依赖:
    pnpm install
  4. 构建项目:
    pnpm run build
  5. 启动服务器:
    pnpm start
    (通常情况下,服务器会由MCP客户端自动启动,此命令主要用于手动测试。)

服务器配置(供客户端使用)

MCP服务器通常由兼容的MCP客户端(如VS Code的AI助手扩展)启动和管理。您需要在客户端的配置中指定如何启动此服务器。

配置信息通常保存在客户端的特定配置文件中(例如 VS Code 的 '.vscode/mcp.json' 或全局 'settings.json')。以下是配置的关键信息描述:

  • 服务器名称: 为您的服务器指定一个唯一的标识符(例如 '"my-mcp-server"')。
  • 启动命令 (command): 指定用于启动服务器进程的可执行程序,对于此Node.js项目,通常是 '"node"'。
  • 启动参数 (args): 指定传递给启动命令的参数,通常是服务器的入口文件路径。对于构建后的项目,路径格式通常是 '["/绝对路径/到/您的/mcp/dist/index.js"]'。请将 '/绝对路径/到/您的/mcp' 替换为您克隆仓库后的实际绝对路径。
  • 环境变量 (env): 一个可选的JSON对象,用于为服务器进程设置环境变量。

重要: 配置完成后,请确保您的MCP客户端已启用MCP服务器的自动发现或已正确加载您的服务器配置。

基本使用方法

  1. 按照上述步骤安装和构建项目。
  2. 根据您的MCP客户端类型(例如 VS Code),按照客户端的文档配置本MCP服务器的启动方式。
  3. 启动您的MCP客户端(如果服务器是配置为由客户端自动启动)。
  4. 客户端会自动启动本MCP服务器,并尝试通过stdio建立连接。
  5. 连接成功后,AI助手即可通过MCP协议调用您在此服务器中注册的工具、访问资源或使用Prompt模板来辅助您的工作。
  6. 要添加或修改AI助手可用的功能(工具、资源、Prompt),需要编辑 'src/tools/index.ts'、'src/resources/index.ts'、'src/prompts/index.ts' 等文件,然后重新构建和启动服务器。

信息

分类

开发者工具