Teamretro MCP Server

🚀 团队复古 MCP 服务器

模型上下文协议（MCP）服务器用于团队复古集成，为团队复古平台提供了一种访问方式。

点击查看

🚀 快速开始

本 MCP 服务器使用简单，按照以下步骤即可轻松配置和运行。

✨ 主要特性

非官方 MCP 服务器

此 MCP 服务器是团队复古社区开发的非官方接口。尽管不是由团队复古开发或认可，但它提供了对其平台的标准访问方式。

正式 API 集成

该服务器直接连接到团队复古的官方公共 API：

• 使用了团队复古 API 文档中记录的端点
• 保持完整的 API 兼容性和版本跟踪
• 实现了所有必需的身份验证方法
• 保留原始 API 响应，不做任何修改

API 文档来源

所有 API 端点和功能均基于团队复古的官方文档：

• API 帮助文章：https://help.teamretro.com/article/320-teamretro-api
• API 规范：https://groupmap.stoplight.io/docs/teamretro/
• 严格遵循公共 API 规范
• 团队复古 API 的任何更改可能会影响此 MCP 服务器的功能

📦 安装指南

使用 NPX（推荐，简单设置）

{
  "mcpServers": {
    "teamretro-mcp-server": {
      "command": "npx",
      "args": []
    }
  }
}

手动安装

1. 克隆仓库：

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

2. 安装依赖项：

   npm install
   

运行服务器

使用 Node.js 运行服务器：

node index.js

💻 使用示例

基础用法

创建新用户

const { createUser } = require('teamretro-mcp-server');

async function main() {
  try {
    const response = await createUser({
      username: 'newuser',
      email: 'newuser@example.com',
      password: 'securepassword'
    });
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

main();

获取项目详情

const { getProject } = require('teamretro-mcp-server');

async function main() {
  try {
    const response = await getProject({
      projectId: '12345'
    });
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

main();

高级用法

环境变量示例

基本配置

# 配置文件路径
export CONFIG_PATH=./config.json

# 日志级别
export LOG_LEVEL=info

高级配置

# 设置代理
export HTTP_PROXY=http://proxy.example.com:8080

# 禁用 SSL 认证
export NODE_NO_HTTPS_CHECK=true

📚 详细文档

工具列表

用户管理

• create_user：创建新用户
• get_user：获取指定用户信息
• update_user：更新用户资料
• delete_user：删除用户

项目管理

• list_projects：列出所有项目
• create_project：创建新项目
• get_project：获取项目详情
• update_project：更新项目信息
• delete_project：删除项目

任务管理

• list_tasks：列出所有任务
• create_task：创建新任务
• get_task：获取任务详情
• update_task：更新任务状态
• delete_task：删除任务

常见问题解答

1. 如何安装依赖？
   • 使用 npm 安装：

     npm install
     

2. 如何启动服务器？
   • 运行主文件：

     node index.js
     

3. 如何配置服务器？
   • 创建 config.json 文件并设置相应参数。

日志记录

配置日志输出

const winston = require('winston');
require('winston-daily-rotate-file');

const logger = new winston.Logger({
  transports: [
    new winston.ConsoleTransport(),
    new winston.DailyRotateFileTransport({
      filename: 'app.log',
      frequency: 'daily'
    })
  ]
});

logger.info('Server started successfully');

错误处理

处理异常

try {
  // 执行操作
} catch (error) {
  logger.error(`Error occurred: ${error.message}`);
}

🔧 技术细节

此 MCP 服务器严格遵循团队复古的官方公共 API 规范，使用了其文档中记录的端点，保持完整的 API 兼容性和版本跟踪，实现了所有必需的身份验证方法，并保留原始 API 响应不做任何修改。团队复古 API 的任何更改可能会影响此 MCP 服务器的功能。

感谢您的耐心阅读！希望这些信息对您有所帮助。如果还有其他问题，请随时查阅文档或与我们联系。