⚠️ 注意：LLM 生成的代码 ⚠️

警告：此代码库由大型语言模型 (LLM) 生成。 尽管已努力确保准确性和功能性，但在生产环境中使用此代码之前，应彻底审查和测试。 使用风险自负。

---

LimeSurvey MCP 服务器

一个模型上下文协议 (MCP) 服务器，它将 LimeSurvey Remote API 功能公开为 MCP 工具。 此服务器提供了一种标准化的方式，通过 MCP 客户端与 LimeSurvey 强大的调查管理功能进行交互。

目录

• 安装
• 配置
• 用法
• API 参考
  • 调查管理
  • 问题管理
  • 回复管理
  • 参与者管理
• 开发
• 许可证

安装

# 克隆仓库
git clone https://github.com/TonisOrmisson/limesurvey-mcp.git
cd limesurvey-mcp

# 安装依赖
npm install

# 构建项目
npm run build

# 启动服务器
npm start

配置

在根目录中创建一个 .env 文件，其中包含以下变量：

# LimeSurvey Remote API 设置
LIMESURVEY_API_URL=https://your-limesurvey-instance.com/admin/remotecontrol
LIMESURVEY_USERNAME=your_username
LIMESURVEY_PASSWORD=your_password

# 服务器设置
PORT=3000

用法

服务器运行后，您可以使用任何 MCP 客户端连接到它并访问 LimeSurvey 功能。

API 参考

调查管理

listSurveys

列出经过身份验证的用户有权访问的所有调查。

参数：无

返回：

• 包含调查对象的数组，具有以下属性：
  • sid: 调查 ID
  • surveyls_title: 调查标题
  • active: 调查是否处于活动状态（“Y”或“N”）
  • expires: 到期日期（如果已设置）
  • startdate: 开始日期（如果已设置）
  • 以及其他调查元数据

示例响应：

[
  {
    "sid": "123456",
    "surveyls_title": "客户满意度调查",
    "active": "Y",
    "expires": null,
    "startdate": "2023-01-01 00:00:00"
  },
  {
    "sid": "789012",
    "surveyls_title": "员工反馈",
    "active": "N",
    "expires": "2023-12-31 23:59:59",
    "startdate": "2023-06-01 00:00:00"
  }
]

getSurveyProperties

获取特定调查的详细属性。

参数：

• surveyId: 要获取属性的调查的 ID

返回：

• 包含调查属性的对象，包括设置、配置和元数据

activateSurvey

激活当前处于非活动状态的调查。

参数：

• surveyId: 要激活的调查的 ID

返回：

• 激活过程的结果

getSurveyLanguageProperties

获取调查的特定于语言的属性。

参数：

• surveyId: 调查的 ID
• language: 语言代码

返回：

• 包含调查的特定于语言的属性的对象

getAvailableLanguages

获取 LimeSurvey 安装中可用的语言。

参数：无

返回：

• 可用语言代码及其名称的列表

getSurveyLanguages

获取特定调查的可用语言。

参数：

• surveyId: 调查的 ID

返回：

• 调查可用的语言代码数组

问题管理

listQuestions

列出特定调查的所有问题。

参数：

• surveyId: 调查的 ID
• groupId (可选): 仅获取此组中的问题
• language (可选): 问题文本的语言

返回：

• 包含问题对象的数组，其属性包括 ID、文本、类型和其他设置

listQuestionGroups

列出特定调查的所有问题组。

参数：

• surveyId: 调查的 ID
• language (可选): 组文本的语言

返回：

• 包含问题组对象的数组，其属性包括 ID、标题、描述和顺序

getQuestionProperties

获取特定问题的属性。

参数：

• questionId: 问题的 ID
• language (可选): 问题文本的语言
• properties (可选): 要检索的属性名称数组

返回：

• 包含问题的请求属性的对象

回复管理

getResponseSummary

获取有关调查收集的回复的摘要信息。

参数：

• surveyId: 调查的 ID

返回：

• 摘要对象，包含有关回复计数和状态的信息

exportResponses

以指定格式从调查中导出回复。

参数：

• surveyId: 调查的 ID
• documentType: 导出格式 (csv, xls, pdf, html, json) - 默认: "csv"
• language (可选): 回复导出的语言
• completionStatus: 按完成状态过滤 ('complete', 'incomplete', 'all') - 默认: "all"
• headingType: 标题类型 ('code', 'full', 'abbreviated') - 默认: "code"
• responseType: 回复类型 ('short' 或 'long') - 默认: "short"
• fields (可选): 要导出的字段名称数组

返回：

• 以请求格式导出的数据

listResponses

列出特定调查的回复 ID。

参数：

• surveyId: 调查的 ID
• start: 起始回复索引 - 默认: 0
• limit: 要返回的回复数 - 默认: 10
• attributes (可选): 要包含的属性名称数组

返回：

• 回复 ID 和请求属性的数组

参与者管理

addParticipant

向调查添加参与者。

参数：

• surveyId: 调查的 ID
• email: 参与者电子邮件地址
• firstName (可选): 名字
• lastName (可选): 姓氏
• language (可选): 语言代码
• usesLeft: 参与者可以访问调查的次数 - 默认: 1
• validFrom (可选): 有效期从 (YYYY-MM-DD HH:mm:ss)
• validUntil (可选): 有效期至 (YYYY-MM-DD HH:mm:ss)

返回：

• 参与者数据，包括生成的令牌

listParticipants

列出特定调查的参与者。

参数：

• surveyId: 调查的 ID
• start: 起始参与者索引 - 默认: 0
• limit: 要返回的参与者数 - 默认: 10
• unused: 仅显示未使用的令牌 - 默认: false
• attributes (可选): 要包含的属性名称数组

返回：

• 包含请求属性的参与者对象数组

getParticipantProperties

获取特定参与者/令牌的属性。

参数：

• surveyId: 调查的 ID
• tokenId: 令牌 ID
• attributes (可选): 要包含的属性名称数组

返回：

• 包含指定参与者的属性的对象

开发

本项目使用以下技术构建：

• Node.js
• @modelcontextprotocol/sdk - MCP 服务器 SDK
• TypeScript - 用于类型安全和现代 JavaScript 功能
• dotenv - 用于环境变量管理
• Axios - 用于向 LimeSurvey Remote API 发送 HTTP 请求

构建

npm run build

开发模式

npm run dev

许可证

MIT