Skip to content

Commit 3c13654

Browse files
ysyneuysyneu
authored
Merge pull request #33 from flashcatcloud/doc-review/2026-03-26-developer-tools
docs: add MCP Server and Terraform Provider documentation
2 parents ca92f0d + 60b1e4a commit 3c13654

File tree

11 files changed

+242
-4
lines changed

11 files changed

+242
-4
lines changed

‎docs.json‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@
3131
"group": "首页",
3232
"pages": [
3333
"zh/home",
34-
"zh/stsatuspage",
35-
"zh/openapi"
34+
"zh/stsatuspage"
3635
]
3736
},
3837
{
@@ -53,6 +52,15 @@
5352
"zh/platform/audit-log"
5453
]
5554
},
55+
{
56+
"group": "开发者",
57+
"pages": [
58+
"zh/developer/overview",
59+
"zh/openapi",
60+
"zh/developer/mcp-server",
61+
"zh/developer/terraform"
62+
]
63+
},
5664
{
5765
"group": "安全合规",
5866
"pages": [
@@ -446,8 +454,7 @@
446454
"group": "Home",
447455
"pages": [
448456
"en/home",
449-
"en/statuspage",
450-
"en/openapi"
457+
"en/statuspage"
451458
]
452459
},
453460
{
@@ -468,6 +475,15 @@
468475
"en/platform/audit-log"
469476
]
470477
},
478+
{
479+
"group": "Developer",
480+
"pages": [
481+
"en/developer/overview",
482+
"en/openapi",
483+
"en/developer/mcp-server",
484+
"en/developer/terraform"
485+
]
486+
},
471487
{
472488
"group": "Compliance",
473489
"pages": [

‎en/developer/mcp-server.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: MCP Server
3+
description: "Connect Flashduty APIs to AI tools via MCP protocol for intelligent incident management"
4+
keywords: ["MCP", "Model Context Protocol", "AI", "Claude", "Cursor"]
5+
url: https://github.com/flashcatcloud/flashduty-mcp-server
6+
---

‎en/developer/overview.mdx‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: Developer tools
3+
description: "Manage Flashduty resources programmatically via API, MCP Server, and Terraform Provider"
4+
---
5+
6+
## Overview
7+
8+
Flashduty provides multiple developer tools to help you programmatically manage incident response workflows, automate operations, and integrate Flashduty into your existing toolchain.
9+
10+
<CardGroup cols={3}>
11+
<Card title="Open API" icon="code" href="https://developer-en.flashcat.cloud/en/flashduty/open-api/quickstart">
12+
RESTful API for accessing and managing Flashduty entities including incidents, alerts, channels, schedules, and more.
13+
</Card>
14+
15+
<Card title="MCP Server" icon="robot" href="https://github.com/flashcatcloud/flashduty-mcp-server">
16+
Model Context Protocol server that connects Flashduty APIs to AI tools like Claude and Cursor, enabling natural language incident management and status page operations.
17+
</Card>
18+
19+
<Card title="Terraform Provider" icon="cube" href="https://registry.terraform.io/providers/flashcatcloud/flashduty/latest/docs">
20+
Terraform Provider for managing channels, escalation rules, schedules, silence rules, and 12 other resource types as infrastructure as code.
21+
</Card>
22+
</CardGroup>
23+
24+
## Open API
25+
26+
The Flashduty Open API follows RESTful conventions and supports APP Key authentication. You can use the API to:
27+
28+
- Create and manage incidents and alerts
29+
- Configure channels and escalation rules
30+
- Query schedules and member information
31+
- Manage integrations and webhooks
32+
33+
<Tip>
34+
Visit the [API documentation](https://developer-en.flashcat.cloud/en/flashduty/open-api/quickstart) for complete endpoint references and request examples.
35+
</Tip>
36+
37+
## MCP Server
38+
39+
The Flashduty MCP Server implements the [Model Context Protocol](https://modelcontextprotocol.io/), providing AI tools with 16 tools across 6 functional modules:
40+
41+
| Module | Tools | Capabilities |
42+
|--------|-------|-------------|
43+
| Incidents | 8 | Query, create, acknowledge, close incidents; view timelines and associated alerts; find similar incidents |
44+
| Changes | 1 | Query change records |
45+
| Status Page | 4 | Query status pages, create events, update timelines |
46+
| Users & Teams | 2 | Query members and team information |
47+
| Channels | 2 | Query channels and escalation rules |
48+
| Custom Fields | 1 | Query custom field definitions |
49+
50+
Three deployment modes are available:
51+
52+
- **Remote service** — Connect directly to `https://mcp.flashcat.cloud/mcp`, no installation required
53+
- **Docker** — Deploy locally using pre-built container image
54+
- **Local build** — Build from source
55+
56+
<Tip>
57+
Visit the [GitHub repository](https://github.com/flashcatcloud/flashduty-mcp-server) for the complete deployment guide and tools reference.
58+
</Tip>
59+
60+
## Terraform Provider
61+
62+
The Flashduty Terraform Provider supports managing 12 resource types and 13 data sources as code:
63+
64+
**Resources (create and manage):**
65+
66+
| Resource | Description |
67+
|----------|-------------|
68+
| `flashduty_team` | Team |
69+
| `flashduty_member_invite` | Member invitation |
70+
| `flashduty_channel` | Channel (with alert grouping, flap detection, auto-resolve configuration) |
71+
| `flashduty_schedule` | Schedule (multi-layer rotation, time restrictions) |
72+
| `flashduty_escalate_rule` | Escalation rule (multi-level, time filters, alert filters) |
73+
| `flashduty_silence_rule` | Silence rule |
74+
| `flashduty_inhibit_rule` | Inhibit rule |
75+
| `flashduty_field` | Custom field |
76+
| `flashduty_route` | Alert routing |
77+
| `flashduty_template` | Notification template |
78+
| `flashduty_alert_pipeline` | Alert processing pipeline |
79+
| `flashduty_incident` | Incident |
80+
81+
**Data sources (query):** Query teams, channels, members, custom fields, notification templates, and routing configurations by ID or name.
82+
83+
<Tip>
84+
Visit the [Terraform Registry](https://registry.terraform.io/providers/flashcatcloud/flashduty/latest/docs) for complete resource attributes and usage examples.
85+
</Tip>

‎en/developer/terraform.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Terraform Provider
3+
description: "Manage Flashduty resources as code using Terraform for infrastructure as code"
4+
keywords: ["Terraform", "IaC", "Infrastructure as Code", "Provider"]
5+
url: https://registry.terraform.io/providers/flashcatcloud/flashduty/latest/docs
6+
---

‎en/on-call/configuration/notifications.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,10 @@ If your team cannot do app integration temporarily, using bots is a simple, quic
248248
</Tab>
249249
</Tabs>
250250

251+
<Tip>
252+
**Don't use any of the above IM platforms? You can still use bot notifications.** Flashduty does not validate the domain of bot webhook URLs, so you can select any bot type (e.g., Dingtalk Bot) and set the webhook URL to your own server endpoint. Simply implement the corresponding IM platform's message push protocol on your server to receive Flashduty alert notifications. This approach is ideal for custom notification systems or integrating with non-standard IM tools. For step-by-step instructions, see the [FAQ](/en/on-call/quickstart/faq#i-dont-use-feishudingtalkwecomtelegram--how-can-i-receive-bot-notifications).
253+
</Tip>
254+
251255
---
252256

253257
## General Configuration

‎en/on-call/quickstart/faq.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,16 @@ description: "Learn about the most common questions when using Flashduty On-call
300300

301301
If you still can't find the cause, please contact us.
302302
</Accordion>
303+
304+
<Accordion title="I don't use Feishu/Dingtalk/WeCom/Telegram — how can I receive bot notifications?">
305+
If you don't use any of the above IM platforms, you can still leverage bot notifications. Flashduty does not validate the domain of bot webhook URLs. You can:
306+
307+
1. Select any bot type (e.g., Dingtalk Bot) in the escalation rules
308+
2. Set the webhook URL to your own server endpoint
309+
3. Implement the corresponding IM platform's message push protocol on your server (i.e., parse the request body according to that platform's message format)
310+
311+
Flashduty will send alert notifications to your server using that IM platform's message format. You can then process and forward them to any notification channel of your choice.
312+
</Accordion>
303313
</AccordionGroup>
304314

305315
## Features and Integrations

‎zh/developer/mcp-server.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: MCP Server
3+
description: "通过 MCP 协议将 Flashduty API 接入 AI 工具，实现智能化故障管理"
4+
keywords: ["MCP", "Model Context Protocol", "AI", "Claude", "Cursor"]
5+
url: https://github.com/flashcatcloud/flashduty-mcp-server
6+
---

‎zh/developer/overview.mdx‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: 开发者工具
3+
description: "通过 API、MCP Server 和 Terraform Provider 以编程方式管理 Flashduty 资源"
4+
---
5+
6+
## 概述
7+
8+
Flashduty 提供多种开发者工具，帮助您以编程方式管理故障响应流程、自动化运维操作，并将 Flashduty 集成到现有工作流中。
9+
10+
<CardGroup cols={3}>
11+
<Card title="Open API" icon="code" href="https://developer.flashcat.cloud/zh/flashduty/open-api/quickstart">
12+
RESTful API，用于访问和操作 Flashduty 的实体数据，包括故障、告警、协作空间、值班表等资源的增删改查。
13+
</Card>
14+
15+
<Card title="MCP Server" icon="robot" href="https://github.com/flashcatcloud/flashduty-mcp-server">
16+
基于 Model Context Protocol 的服务端，将 Flashduty API 接入 Claude、Cursor 等 AI 工具，实现通过自然语言查询故障、管理状态页、查看值班信息。
17+
</Card>
18+
19+
<Card title="Terraform Provider" icon="cube" href="https://registry.terraform.io/providers/flashcatcloud/flashduty/latest/docs">
20+
Terraform Provider，支持以代码方式管理协作空间、分派策略、值班表、静默策略等 12 类资源，实现基础设施即代码。
21+
</Card>
22+
</CardGroup>
23+
24+
## Open API
25+
26+
Flashduty Open API 采用 RESTful 风格，支持通过 APP Key 进行身份验证。您可以使用 API 完成以下操作：
27+
28+
- 创建和管理故障、告警
29+
- 配置协作空间和分派策略
30+
- 查询值班表和成员信息
31+
- 管理集成和 Webhook
32+
33+
<Tip>
34+
访问 [API 文档](https://developer.flashcat.cloud/zh/flashduty/open-api/quickstart) 查看完整的接口说明和请求示例。
35+
</Tip>
36+
37+
## MCP Server
38+
39+
Flashduty MCP Server 实现了 [Model Context Protocol](https://modelcontextprotocol.io/)，为 AI 工具提供 16 个工具，覆盖 6 个功能模块：
40+
41+
| 模块 | 工具数 | 功能 |
42+
|------|--------|------|
43+
| 故障管理 | 8 | 查询、创建、认领、关闭故障，查看时间线和关联告警，查找相似故障 |
44+
| 变更管理 | 1 | 查询变更记录 |
45+
| 状态页 | 4 | 查询状态页、创建事件、更新时间线 |
46+
| 用户与团队 | 2 | 查询成员和团队信息 |
47+
| 协作空间 | 2 | 查询协作空间和分派策略 |
48+
| 自定义字段 | 1 | 查询自定义字段定义 |
49+
50+
支持三种部署方式：
51+
52+
- **远程服务** — 直接连接 `https://mcp.flashcat.cloud/mcp`，无需安装
53+
- **Docker** — 使用预构建镜像本地部署
54+
- **本地编译** — 从源码构建
55+
56+
<Tip>
57+
访问 [GitHub 仓库](https://github.com/flashcatcloud/flashduty-mcp-server) 查看完整的部署指南和工具参考。
58+
</Tip>
59+
60+
## Terraform Provider
61+
62+
Flashduty Terraform Provider 支持以代码方式管理 12 类资源和 13 类数据源：
63+
64+
**资源（可创建和管理）：**
65+
66+
| 资源 | 说明 |
67+
|------|------|
68+
| `flashduty_team` | 团队 |
69+
| `flashduty_member_invite` | 成员邀请 |
70+
| `flashduty_channel` | 协作空间（含告警聚合、抖动检测、自动关闭配置） |
71+
| `flashduty_schedule` | 值班表（支持多层轮换、时间限制） |
72+
| `flashduty_escalate_rule` | 分派策略（多环节、时间过滤、告警过滤） |
73+
| `flashduty_silence_rule` | 静默策略 |
74+
| `flashduty_inhibit_rule` | 抑制策略 |
75+
| `flashduty_field` | 自定义字段 |
76+
| `flashduty_route` | 告警路由 |
77+
| `flashduty_template` | 通知模板 |
78+
| `flashduty_alert_pipeline` | 告警处理流水线 |
79+
| `flashduty_incident` | 故障 |
80+
81+
**数据源（可查询）：** 支持按 ID 或名称查询团队、协作空间、成员、自定义字段、通知模板和路由配置。
82+
83+
<Tip>
84+
访问 [Terraform Registry](https://registry.terraform.io/providers/flashcatcloud/flashduty/latest/docs) 查看完整的资源属性和使用示例。
85+
</Tip>

‎zh/developer/terraform.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Terraform Provider
3+
description: "使用 Terraform 以代码方式管理 Flashduty 资源，实现基础设施即代码"
4+
keywords: ["Terraform", "IaC", "基础设施即代码", "Provider"]
5+
url: https://registry.terraform.io/providers/flashcatcloud/flashduty/latest/docs
6+
---

‎zh/on-call/configuration/notifications.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,10 @@ Flashduty App 是 On-call 工程师最高效的移动办公工具。无论您身
249249
</Tab>
250250
</Tabs>
251251

252+
<Tip>
253+
**没有上述 IM 平台？您仍然可以使用机器人通知。** Flashduty 不会校验机器人 Webhook 地址的域名，因此您可以选择任意一种机器人类型（如钉钉机器人），将 Webhook 地址填写为您自己的服务端 URL。只需在您的服务端实现对应 IM 平台的消息推送协议，即可接收 Flashduty 的告警通知。这种方式适合自研通知系统或需要对接非标准 IM 工具的场景。详细步骤请参考[常见问题](/zh/on-call/quickstart/faq#我没有飞书钉钉企微telegram如何接收机器人通知)。
254+
</Tip>
255+
252256
---
253257

254258
## 通用配置

0 commit comments

Comments
 (0)