项目说明

这是一个使用Node.js和TypeScript编写的MCP（模型上下文协议）服务器端程序，用于通过LimeSurvey进行数据收集。该程序允许您创建API来管理调查、参与者和导出结果。

安装指南

先决条件

• Node.js 16.0或更高版本
• npm 5.0或更高版本
• Docker（可选，用于生产环境部署）

安装步骤

1. 克隆此仓库到本地：

git clone https://github.com/yourusername/limesurvey-mcp-server.git

2. 进入项目目录：

cd limesurvey-mcp-server

3. 使用npm安装依赖项：

npm install

配置

环境变量

创建一个.env文件并添加以下内容：

LIMESURVEY_API_URL=你的LimeSurvey API URL
LIMESURVEY_API_TOKEN=你的LimeSurvey API令牌
PORT=3000

快速开始

启动开发服务器

npm run dev

服务器将在http://localhost:3000启动。

创建MCP端点

在项目根目录下创建一个名为endpoints的文件夹，并添加您的自定义端点逻辑。

API参考

调查管理

创建调查

POST /api/surveys
Content-Type: application/json

{
  "surveyId": "123456",
  "title": "我的第一次调查",
  "description": "这是一个测试调查。"
}

获取所有调查

GET /api/surveys

参与者管理

添加参与者

POST /api/surveys/{surveyId}/participants
Content-Type: application/json

{
  "email": "test@example.com",
  "firstName": "测试",
  "lastName": "用户",
  "language": "zh_CN"
}

开发信息

使用的工具和技术

• Node.js - 用于服务器端逻辑
• TypeScript - 提供类型安全和现代JavaScript功能
• Docker - 用于容器化部署（可选）
• Axios - 处理HTTP请求到LimeSurvey API

构建项目

npm run build

许可证

MIT