Attention: Llm Generated Code

🚀 MCP Server for LimeSurvey

This is an MCP (Model Context Protocol) server-side program written in Node.js and TypeScript, designed for data collection through LimeSurvey. It allows you to create APIs to manage surveys, participants, and export results.

🚀 Quick Start

Start the Development Server

npm run dev

The server will start at http://localhost:3000.

Create MCP Endpoints

Create a folder named endpoints in the project root directory and add your custom endpoint logic.

✨ Features

• Create APIs to manage surveys, participants, and export results.
• Support for LimeSurvey data collection.

📦 Installation

Prerequisites

• Node.js version 16.0 or higher
• npm version 5.0 or higher
• Docker (optional, for production deployment)

Installation Steps

1. Clone this repository to your local machine:

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

2. Navigate to the project directory:

cd limesurvey-mcp-server

3. Install dependencies using npm:

npm install

📚 Documentation

Configuration

Environment Variables

Create a .env file and add the following content:

LIMESURVEY_API_URL=Your LimeSurvey API URL
LIMESURVEY_API_TOKEN=Your LimeSurvey API token
PORT=3000

API Reference

Survey Management

Create a Survey

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

{
  "surveyId": "123456",
  "title": "My First Survey",
  "description": "This is a test survey."
}

Get All Surveys

GET /api/surveys

Participant Management

Add a Participant

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

{
  "email": "test@example.com",
  "firstName": "Test",
  "lastName": "User",
  "language": "zh_CN"
}

Development Information

Tools and Technologies Used

• Node.js - For server-side logic
• TypeScript - Provides type safety and modern JavaScript features
• Docker - For containerized deployment (optional)
• Axios - Handles HTTP requests to the LimeSurvey API

Build the Project

npm run build

📄 License

MIT