Flashduty MCP Server

🚀 Flashduty MCP Server

The Flashduty MCP Server is a Model Context Protocol (MCP) server. It offers seamless integration with Flashduty APIs, empowering developers and tools with advanced incident management and automation capabilities.

🚀 Quick Start

The Flashduty MCP Server provides two deployment options: remote and local. Choose the appropriate method based on your MCP host's capabilities and your specific requirements.

✨ Features

• Automation: Automate Flashduty workflows and processes.
• Data Analysis: Extract and analyze data from Flashduty.
• AI Integration: Build AI - powered tools and applications that interact with Flashduty.
• Flexible Configuration: Support various configuration options, including toolset selection, read - only mode, and i18n.

📦 Installation

Remote Flashduty MCP Server

The remote Flashduty MCP Server is the easiest way to start integrating with Flashduty. If your MCP host does not support remote MCP servers, use the local version instead.

Prerequisites

1. An MCP host that supports the latest MCP specification and remote servers, such as Cursor.
2. A Flashduty APP key from your Flashduty account.

Installation Steps

For Cursors that support Remote MCP, use the following configuration:

{
  "mcpServers": {
    "flashduty": {
      "url": "https://mcp.flashcat.cloud/flashduty",
      "authorization_token": "Bearer <your_flashduty_app_key>"
    }
  }
}

⚠️ Important Note

Refer to your MCP host's documentation for the correct syntax and location for remote MCP server setup.

Local Flashduty MCP Server

Prerequisites

1. Docker installed and running if you want to run the server in a container.
2. A Flashduty APP key from your Flashduty account.

Installation Steps

Using Docker

Add the following JSON block to your Cursor MCP configuration.

{
  "mcpServers": {
    "flashduty": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "FLASHDUTY_APP_KEY",
        "flashcat.tencentcloudcr.com/flashduty/flashduty-mcp-server"
      ],
      "env": {
        "FLASHDUTY_APP_KEY": "your_flashduty_app_key"
      }
    }
  }
}

Using binary

You can download a pre - compiled version for your operating system directly from the project's GitHub Releases. If you prefer to build from source, use go build in the cmd/flashduty-mcp-server directory. You can provide the APP key either via environment variable or command - line argument.

Via Environment Variable:

{
  "mcpServers": {
    "flashduty": {
      "command": "/path/to/flashduty-mcp-server",
      "args": ["stdio"],
      "env": {
        "FLASHDUTY_APP_KEY": "your_app_key_here"
      }
    }
  }
}

Via Command - line Argument:

{
  "mcpServers": {
    "flashduty": {
      "command": "/path/to/flashduty-mcp-server",
      "args": ["stdio", "--app-key", "your_app_key_here"]
    }
  }
}

📚 Documentation

Tool Configuration

The Flashduty MCP Server supports several configuration options, including toolsets, read - only mode, and i18n. Configuration methods are divided into remote and local service configurations.

Remote Server Configuration

When using the public remote service (https://mcp.flashcat.cloud/flashduty), you can dynamically configure it by appending query parameters to the URL.

Configuration Example

{
  "mcpServers": {
    "flashduty": {
      "url": "https://mcp.flashcat.cloud/flashduty?toolsets=flashduty_incidents,flashduty_teams&read_only=true",
      "authorization_token": "Bearer <your_flashduty_app_key>"
    }
  }
}

• toolsets=...: Use a comma - separated list to specify the toolsets to enable.
• read_only=true: Enables read - only mode.

Local Server Configuration

When running the service locally via Docker or from source, you have full configuration control.

1. Via Environment Variables

Docker Example:

docker run -i --rm \
  -e FLASHDUTY_APP_KEY=<your-app-key> \
  -e FLASHDUTY_TOOLSETS="flashduty_incidents,flashduty_teams" \
  -e FLASHDUTY_READ_ONLY=1 \
  flashcat.tencentcloudcr.com/flashduty/flashduty-mcp-server

2. Via Command - Line Arguments

./flashduty-mcp-server stdio \
  --app-key your_app_key_here \
  --toolsets flashduty_incidents,flashduty_teams \
  --read-only

Available command - line arguments:

• --app-key: Flashduty APP key (alternative to FLASHDUTY_APP_KEY environment variable)
• --toolsets: Comma - separated list of toolsets to enable
• --read-only: Enable read - only mode
• --base-url: Flashduty API base URL
• --log-file: Path to log file
• --enable-command-logging: Enable command logging
• --export-translations: Save translations to a JSON file

⚠️ Important Note

Command - line arguments take precedence over environment variables. For toolsets configuration, if both FLASHDUTY_TOOLSETS environment variable and --toolsets argument are set, the command - line argument takes priority.

3. i18n / Overriding Descriptions (Local - Only)

Via JSON File: Create flashduty-mcp-server-config.json in the same directory as the binary:

{
  "TOOL_CREATE_INCIDENT_DESCRIPTION": "an alternative description",
  "TOOL_LIST_TEAMS_DESCRIPTION": "List all teams in Flashduty account"
}

Via Environment Variables:

export FLASHDUTY_MCP_TOOL_CREATE_INCIDENT_DESCRIPTION="an alternative description"

Available Toolsets

Tools

flashduty_members - Member Management Tools

• flashduty_member_infos - Get member information by person IDs

flashduty_teams - Team Management Tools

• flashduty_teams_infos - Get team information by team IDs

flashduty_channels - Channel Management Tools

• flashduty_channels_infos - Get collaboration space information by channel IDs

flashduty_incidents - Incident Management Tools

• flashduty_incidents_infos - Get incident information by incident IDs
• flashduty_list_incidents - List incidents with comprehensive filters
• flashduty_list_past_incidents - List similar historical incidents
• flashduty_get_incident_timeline - Get incident timeline and feed
• flashduty_get_incident_alerts - Get alerts associated with incidents
• flashduty_create_incident - Create a new incident
• flashduty_ack_incident - Acknowledge incidents
• flashduty_resolve_incident - Resolve incidents
• flashduty_assign_incident - Assign incidents to people or escalation rules
• flashduty_add_responder - Add responders to incidents
• flashduty_snooze_incident - Snooze incidents for a period
• flashduty_merge_incident - Merge multiple incidents into one
• flashduty_comment_incident - Add comments to incidents
• flashduty_update_incident_title - Update incident title
• flashduty_update_incident_description - Update incident description
• flashduty_update_incident_impact - Update incident impact
• flashduty_update_incident_root_cause - Update incident root cause
• flashduty_update_incident_resolution - Update incident resolution
• flashduty_update_incident_severity - Update incident severity
• flashduty_update_incident_fields - Update custom fields

🔧 Technical Details

The exported Go API of this module is currently considered unstable and subject to breaking changes. In the future, we may offer stability. Please file an issue if there is a use case where this would be valuable.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.