a-simple-mcp-server

🚀 一个简单的MCP服务器

本项目是一个提供用户数据管理工具的Model Context Protocol (MCP)服务器实现，能有效助力用户进行数据管理。

✨ 主要特性

• 用户数据检索工具：可方便地检索用户数据。
• TypeScript实现：保证代码的类型安全和可维护性。
• ES模块支持：支持最新的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. 检查器将在http://localhost:5173可用。

MCP配置

若要与Cursor一起使用此MCP服务器，您需要在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许可证。