Teamretro MCP Server

🚀 Team Retro MCP Server

The Model Context Protocol (MCP) server is used for Team Retro integration.

🚀 Quick Start

This document will guide you through the setup, usage, and management of the Team Retro MCP Server.

⚠️ Important Note

Unofficial MCP Server

This MCP server is an unofficial interface developed by the Team Retro community. Although it is not developed or endorsed by Team Retro, it provides a standard way to access its platform.

Formal API Integration

This server directly connects to Team Retro's official public API:

• It uses the endpoints documented in the Team Retro API documentation.
• It maintains full API compatibility and version tracking.
• It implements all required authentication methods.
• It retains the original API responses without any modifications.

API Documentation Source

All API endpoints and features are based on Team Retro's official documentation:

• API help article: https://help.teamretro.com/article/320-teamretro-api
• API specification: https://groupmap.stoplight.io/docs/teamretro/
• It strictly adheres to the public API specification.
• Any changes to the Team Retro API may affect the functionality of this MCP server.

📦 Installation

Using NPX (Recommended, Simple Setup)

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

Manual Installation

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

💻 Usage Examples

Starting the Server

1. Run the server using Node.js:

   node index.js
   

Environment Variable Examples

Basic Configuration

# Configuration file path
export CONFIG_PATH=./config.json

# Log level
export LOG_LEVEL=info

Advanced Configuration

# Set proxy
export HTTP_PROXY=http://proxy.example.com:8080

# Disable SSL verification
export NODE_NO_HTTPS_CHECK=true

Tool List

User Management

• create_user: Create a new user
• get_user: Get information about a specified user
• update_user: Update user profile
• delete_user: Delete a user

Project Management

• list_projects: List all projects
• create_project: Create a new project
• get_project: Get project details
• update_project: Update project information
• delete_project: Delete a project

Task Management

• list_tasks: List all tasks
• create_task: Create a new task
• get_task: Get task details
• update_task: Update task status
• delete_task: Delete a task

Code Examples

Creating a New User

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();

Getting Project Details

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();

Logging

Configuring Log Output

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');

Error Handling

Handling Exceptions

try {
  // Perform operations
} catch (error) {
  logger.error(`Error occurred: ${error.message}`);
}

📚 Documentation

Frequently Asked Questions

1. How to install dependencies?

   • Install using npm:

     npm install
     

2. How to start the server?

   • Run the main file:

     node index.js
     

3. How to configure the server?

   • Create a config.json file and set the corresponding parameters.

🔚 Summary

By following the above steps, you can easily configure and run the Team Retro MCP server. Whether it's user management, project management, or task management, this server provides powerful functionality.

Thank you for your patience in reading! We hope this information is helpful to you. If you have any other questions, please feel free to refer to the documentation or contact us.