使用说明

项目简介

'mcp-server-template' 是一个用于构建 MCP (Model Context Protocol) 服务器的启动模板。它基于 TypeScript 开发，并使用了 '@modelcontextprotocol/sdk' 库，提供了一个基础的 MCP 服务器框架和示例工具，方便开发者快速上手并构建自己的 MCP 服务器。你可以使用这个模板创建能够与 Cursor 或 Claude Desktop 等 LLM 客户端集成的 MCP 服务器，扩展这些客户端的功能。

主要功能点

基础MCP服务器框架: 提供了搭建 MCP 服务器所需的基本结构和配置。
示例工具: 包含一个简单的示例工具，演示了如何注册和实现工具功能。
易于上手: 项目结构清晰，配置简单，方便开发者快速开始构建自己的 MCP 服务器。
兼容 Cursor 和 Claude Desktop: 提供了在 Cursor 和 Claude Desktop 中配置和使用 MCP 服务器的指南。

安装步骤

克隆仓库:

git clone https://github.com/jatinsandilya/mcp-server-template my-mcp-server
cd my-mcp-server

安装依赖:
```
pnpm install
```
构建项目:
```
pnpm run build
```
构建成功后，会在 'build' 目录下生成 'index.js' 文件，这就是编译后的 MCP 服务器脚本。

服务器配置

MCP 服务器需要配置到 MCP 客户端才能使用，例如 Cursor 或 Claude Desktop。以下分别是在这两种客户端中的配置方法：

Cursor 配置

在 Cursor 设置中，找到 MCP 服务器配置，点击 "Add new MCP server" 并进行如下配置：

{
  "name": "your-mcp-name",  //  自定义MCP服务器名称，例如 "my-custom-mcp"
  "type": "command",
  "command": "node",
  "args": ["ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js"] //  将 ABSOLUTE_PATH_TO_MCP_SERVER 替换为你的 mcp-server-template 项目 build 目录的绝对路径
}

Claude Desktop 配置

在 Claude Desktop 的配置文件中 (通常是 JSON 格式的配置文件，具体位置请参考 Claude Desktop 的文档)，添加如下 MCP 服务器配置：

{
  "mcpServers": {
    "your-mcp-name": {  //  自定义MCP服务器名称，例如 "my-custom-mcp"
      "command": "node",
      "args": ["ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js"] //  将 ABSOLUTE_PATH_TO_MCP_SERVER 替换为你的 mcp-server-template 项目 build 目录的绝对路径
    }
  }
}

基本使用方法

启动 MCP 服务器: 按照上述 Cursor 或 Claude Desktop 的配置，客户端在需要时会自动启动 MCP 服务器。或者你也可以手动在终端运行 'node ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js' 来启动服务器。
调用工具: 在 Cursor 或 Claude Desktop 中，你可以通过特定的指令（通常是 '@工具名' 的形式，例如 '@sample-tool'）来调用 MCP 服务器提供的工具。示例代码中定义了一个名为 'sample-tool' 的工具，你可以尝试在客户端中使用 '@sample-tool' 并跟随提示输入参数来测试该工具。

开发自定义 MCP 服务器

你可以修改 'index.ts' 文件来开发自己的 MCP 服务器：

修改服务器名称和版本: 在 'index.ts' 文件中，修改 'McpServer' 构造函数的参数来设置你的服务器名称和版本。
定义自定义工具: 使用 'server.tool()' 方法注册新的工具。你需要提供工具名称、描述、参数定义（使用 Zod schema）和工具的实现逻辑。
构建和测试: 修改完成后，重新运行 'pnpm run build' 构建项目，并在 Cursor 或 Claude Desktop 中测试你的自定义工具。

关键词

使用说明

信息