flashduty-mcp-server

README

Flashduty MCP Server

English | 中文

The Flashduty MCP Server is a Model Context Protocol (MCP) server that provides seamless integration with Flashduty APIs, enabling advanced incident management and automation capabilities for developers and tools.

Use Cases

• Automating Flashduty workflows and processes.
• Extracting and analyzing data from Flashduty.
• Building AI-powered tools and applications that interact with Flashduty.

---

Remote Flashduty MCP Server

The remote Flashduty MCP Server provides the easiest method for getting up and running with Flashduty integration. If your MCP host does not support remote MCP servers, you can use the local version of the Flashduty MCP Server 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

For example, with Cursor:

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>"
    }
  }
}

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. To run the server in a container, you will need to have Docker installed and running.
2. You will need a Flashduty APP key from your Flashduty account.

Installation

For example, with Cursor:

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

Besides building from source, you can also download a pre-compiled version for your operating system directly from the project's GitHub Releases, which is a faster and more convenient option.

If you prefer to build from source, you can use go build to build the binary in the cmd/flashduty-mcp-server directory. You can provide the APP key either via environment variable or command-line argument.

You should configure your MCP host to use the built executable as its command. For example:

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"]
    }
  }
}

---

Tool Configuration

The Flashduty MCP Server supports several configuration options for different use cases. The main options include:

• Toolsets: Allows you to enable or disable specific groups of functionalities. Enabling only the toolsets you need can help the LLM with tool choice and reduce the context size.
• Read-Only Mode: Restricts the server to read-only operations, preventing any modifications and enhancing security.
• i18n: Supports customizing tool descriptions to suit different languages or team preferences.

Configuration methods are divided into Remote Service Configuration and Local Service Configuration.

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

Here is an example of configuring the remote service, specifying toolsets and read-only mode:

{
  "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

This is the most common method for local configuration, especially in a Docker environment.

Variable	Description	Required	Default
FLASHDUTY_APP_KEY	Flashduty APP key	✅	-
FLASHDUTY_TOOLSETS	Toolsets to enable (comma-separated)	❌	All toolsets
FLASHDUTY_READ_ONLY	Restrict to read-only operations (1 or true)	❌	false
FLASHDUTY_BASE_URL	Flashduty API base URL	❌	https://api.flashcat.cloud
FLASHDUTY_LOG_FILE	Log file path	❌	stderr
FLASHDUTY_ENABLE_COMMAND_LOGGING	Enable command logging	❌	false

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

If you build and run the binary directly from the source, you can use 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

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)

The feature to override tool descriptions is only available for local deployments. You can achieve this by creating a flashduty-mcp-server-config.json file or by setting environment variables.

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

The following toolsets are available (all are on by default). You can also use all to enable all toolsets.

Toolset	Description
flashduty_incidents	Flashduty incident management tools
flashduty_members	Flashduty member management tools
flashduty_teams	Flashduty team management tools
flashduty_channels	Flashduty collaboration channel management tools

---

Tools

The server provides the following toolsets based on Flashduty API:

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

---

Library Usage

The exported Go API of this module should currently be 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.