使用说明

项目简介

本项目 'mcp-userapi' 是一个基于 Model Context Protocol (MCP) 实现的服务器，旨在为大型语言模型 (LLM) 应用提供用户和房产管理功能。它通过 MCP 协议将用户认证、用户管理 (创建、读取、更新、删除) 和房产管理 (列表、读取、创建、更新、删除) 等操作以 工具 (Tools) 的形式暴露出来，使得 LLM 可以通过调用这些工具来与后端系统进行交互，实现用户和房产数据的管理。

主要功能点

用户认证：提供用户登录工具，验证用户身份并获取访问令牌。
用户管理：提供用户信息的增删改查工具，包括创建用户、获取用户列表、查询用户信息、更新用户信息和删除用户。
房产管理：提供房产信息的增删改查工具，包括获取房产列表、查询房产信息、创建房产、更新房产信息和删除房产。
基于 MCP 协议：遵循 Model Context Protocol 标准，易于与 MCP 客户端集成。
支持 Stdio 和 SSE 传输：可以通过标准输入输出 (stdio) 或服务器发送事件 (SSE) 协议与客户端通信。

安装步骤

克隆仓库

git clone https://github.com/robinong79/mcp-userapi.git
cd mcp-userapi

安装依赖
```
npm install
```
构建项目
```
npm run build
```

服务器配置

对于 MCP 客户端，需要配置以下信息以连接到此 MCP 服务器。

{
  "serverName": "MCP Real Estate Agent",
  "command": "npm",
  "args": ["start"],
  "transport": "stdio"
}

配置参数说明:

'serverName': MCP 服务器的名称，此处设置为 "MCP Real Estate Agent"。
'command': 启动 MCP 服务器的命令，此处使用 'npm'。
'args': 启动命令的参数，此处使用 '["start"]'，即运行 'npm start' 命令。
'transport': MCP 服务器使用的传输协议，此处设置为 'stdio'，表示使用标准输入输出进行通信。也可以根据需要配置为 'sse' 以使用 SSE 协议 (仓库描述支持 SSE)。

注意: 确保后端 RESTful API 服务器运行在 'http://127.0.0.1:5000'，此 MCP 服务器依赖于该后端 API 提供数据。

基本使用方法

启动 MCP 服务器：按照上述服务器配置，MCP 客户端将通过 'npm start' 命令启动 'mcp-userapi' 服务器。

调用 MCP 工具：在 MCP 客户端中，可以使用 'client.callTool' 方法调用服务器提供的工具。例如，调用 'login' 工具进行用户登录：

const result = await client.callTool("login", {
  email: "[email protected]",
  password: "securepassword123"
});
console.log(result);

更多工具的使用方法和参数，请参考仓库 'README.md' 文件中 "MCP Tools" 部分的说明和示例代码。例如，可以使用 'list-users'、'create-property' 等工具进行用户和房产管理操作。

关键词