使用说明

项目简介

MCP Server Starter Kit 是一个用于快速搭建本地 Model Context Protocol (MCP) 服务器的脚手架项目。它提供了一个基础的服务器框架和示例工具，帮助开发者轻松创建自定义工具，并通过 MCP 协议与 AI 助手（如 Cursor）进行集成。

主要功能点

MCP 协议兼容: 遵循 Model Context Protocol 标准，可以与任何 MCP 客户端轻松集成。
可扩展的工具: 提供简单的工具注册机制，方便开发者添加自定义工具功能。
快速启动: 预配置了基础服务器结构，开发者可以快速上手并进行定制。
示例工具: 包含一个简单的示例工具 'exampleTool'，展示工具注册和调用的基本流程。
TypeScript 支持: 使用 TypeScript 开发，提供类型安全和更好的开发体验。

安装步骤

克隆仓库:

git clone https://github.com/instructa/mcp-starter.git
cd mcp-starter

安装依赖:

npm install
# 或使用 yarn
# yarn install

启动服务器:

npm start
# 或使用 yarn
# yarn start

服务器默认在本地启动，并等待 MCP 客户端连接。

服务器配置

要将此 MCP 服务器集成到 MCP 客户端（例如 Cursor），您需要在客户端的 MCP 配置文件（通常是 '.cursor/mcp.json'）中添加以下服务器配置。

{
  "mcpServers": {
    "my-starter-mcp": {  // 服务器名称，您可以自定义
      "command": "node",  // 启动服务器的命令，这里使用 node
      "args": ["./dist/index.mjs"] // 启动命令的参数，指向编译后的服务器入口文件
    }
  }
}

配置参数说明:

'my-starter-mcp': 服务器的唯一名称，在客户端中用于标识和引用该服务器。您可以根据需要自定义此名称。
'command': 运行服务器端程序的命令。由于此项目使用 Node.js 开发，因此这里设置为 'node'。
'args': 传递给 'command' 的参数，用于指定服务器入口文件。'./dist/index.mjs' 指向项目编译输出目录 'dist' 下的 'index.mjs' 文件，这是服务器的启动入口点。

请注意:

确保您的 MCP 客户端配置文件路径正确（例如 Cursor 的 '.cursor/mcp.json'）。
'command' 和 'args' 需要根据您的实际环境和项目结构进行调整。
如果您的服务器需要环境变量，可以在 'env' 字段中进行配置（此示例中未包含）。

基本使用方法

确保 MCP 服务器已成功启动（通过 'npm start' 或 'yarn start' 命令）。
配置您的 MCP 客户端 (例如 Cursor) 并添加上述服务器配置。
在 MCP 客户端中，您应该能够发现并调用服务器提供的工具（例如示例中的 'exampleTool'，实际工具名称为 'doSomething'）。
根据 'src/tools/mytool.ts' 中 'registerMyTool' 函数的定义，示例工具 'doSomething' 接受 'param1' 和 'param2' 两个字符串参数。您可以在 MCP 客户端中尝试调用该工具，并传递相应的参数进行测试。

开发自定义工具:

您可以参考 'src/tools/mytool.ts' 文件，创建新的工具文件并在 'src/index.ts' 中引入和注册您的自定义工具。

关键词