一个简单的 MCP 服务器

一个模型上下文协议 (MCP) 服务器的实现，提供用户数据管理工具。

<div align="center"> <img src="./inspector.png" alt="MCP Server Logo" width="100%"/> </div>

特性

• 用户数据检索工具
• TypeScript 实现
• ES 模块支持
• 内置 TypeScript 编译

前提条件

• Node.js (v20 或更高版本)
• npm (v9 或更高版本)

安装

1. 克隆仓库:

git clone https://github.com/fujahgabriel/simple-mcp-server.git
cd simple-mcp-server

2. 安装依赖:

npm install

开发

构建项目

构建 TypeScript 文件:

npm run build

这将会:

• 将 TypeScript 文件编译为 JavaScript
• 将文件输出到 build 目录
• 设置输出文件的正确权限

开发模式

监听文件更改并自动重新构建:

npm run watch

使用 MCP Inspector

检查和测试您的 MCP 服务器工具:

1. 首先构建项目:

npm run build

2. 启动 MCP Inspector:

npm run inspector

3. Inspector 将在 http://localhost:5173 上可用

MCP 配置

要将此 MCP 服务器与 Cursor 一起使用，您需要在 MCP 设置中对其进行配置。 将以下配置添加到您的 ~/.cursor/mcp.json：

{
  "my-mcp-server": {
    "math": {
      "command": "node",
      "args": ["build/index.js"]
    }
  }
}

请确保:

1. 首先使用 npm run build 构建项目
2. 使用构建的 JavaScript 文件的正确路径
3. 更新配置后重新启动 Cursor

可用工具

get_users

检索所有用户的列表。

get_user

按名称检索特定用户。

参数:

• user: string - 要检索的用户的名称

项目结构

mcp-server/
├── build/           # 编译后的 JavaScript 文件
├── index.ts         # 主要服务器实现
├── package.json     # 项目依赖和脚本
└── tsconfig.json    # TypeScript 配置

依赖

• @modelcontextprotocol/sdk: 用于服务器实现的 MCP SDK
• dotenv: 环境变量管理
• typescript: TypeScript 编译器
• zod: 运行时类型验证

许可证

MIT