> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# 开发者工具

> 通过 API、CLI、MCP Server 和 Terraform Provider 以编程方式管理 Flashduty 资源

## 概述

Flashduty 提供多种开发者工具，帮助您以编程方式管理故障响应流程、自动化运维操作，并将 Flashduty 集成到现有工作流中。

<CardGroup cols={2}>
  <Card title="Open API" icon="code" href="/zh/openapi/introduction">
    RESTful API，用于访问和操作 Flashduty 的实体数据，包括故障、告警、协作空间、值班表等资源的增删改查。
  </Card>

  <Card title="命令行工具" icon="terminal" href="/zh/developer/cli">
    Flashduty CLI，在终端中管理故障、值班、状态页和通知模板，覆盖 macOS、Linux 和 Windows，并内置 10 个 AI 编程代理技能。
  </Card>

  <Card title="MCP Server" icon="robot" href="https://github.com/flashcatcloud/flashduty-mcp-server">
    基于 Model Context Protocol 的服务端，将 Flashduty API 接入 Claude、Cursor 等 AI 工具，实现通过自然语言查询故障、管理状态页、查看值班信息。
  </Card>

  <Card title="Terraform Provider" icon="cube" href="https://registry.terraform.io/providers/flashcatcloud/flashduty/latest/docs">
    Terraform Provider，支持以代码方式管理协作空间、分派策略、值班表、静默策略等 12 类资源，实现基础设施即代码。
  </Card>
</CardGroup>

## Open API

Flashduty Open API 采用 RESTful 风格，支持通过 APP Key 进行身份验证。您可以使用 API 完成以下操作：

* 创建和管理故障、告警
* 配置协作空间和分派策略
* 查询值班表和成员信息
* 管理集成和 Webhook

<Tip>
  访问 [API 文档](/zh/openapi/introduction) 查看完整的接口说明和请求示例。
</Tip>

## 命令行工具

Flashduty CLI（`flashduty`）是一款命令行工具，可在终端中完成故障生命周期管理、值班查询、状态页发布和通知模板调试。支持 macOS、Linux 和 Windows，并内置 10 个 Agent Skills，可与 Claude Code、Cursor、Codex、Gemini CLI 等 AI 编程代理协同工作。

一行命令安装：

```bash theme={null}
curl -sSL https://raw.githubusercontent.com/flashcatcloud/flashduty-cli/main/install.sh | sh
```

<Tip>
  访问 [命令行工具](/zh/developer/cli) 文档查看完整安装方式、命令清单和最佳实践。
</Tip>

## MCP Server

Flashduty MCP Server 实现了 [Model Context Protocol](https://modelcontextprotocol.io/)，为 AI 工具提供 18 个工具，覆盖 6 个功能模块：

| 模块    | 工具数 | 功能                              |
| ----- | --- | ------------------------------- |
| 故障管理  | 8   | 查询、创建、认领、关闭故障，查看时间线和关联告警，查找相似故障 |
| 变更管理  | 1   | 查询变更记录                          |
| 状态页   | 4   | 查询状态页、创建事件、更新时间线                |
| 用户与团队 | 2   | 查询成员和团队信息                       |
| 协作空间  | 2   | 查询协作空间和分派策略                     |
| 自定义字段 | 1   | 查询自定义字段定义                       |

支持三种部署方式：

* **远程服务** — 直接连接 `https://mcp.flashcat.cloud/mcp`，无需安装
* **Docker** — 使用预构建镜像本地部署
* **本地编译** — 从源码构建

<Tip>
  访问 [GitHub 仓库](https://github.com/flashcatcloud/flashduty-mcp-server) 查看完整的部署指南和工具参考。
</Tip>

## Terraform Provider

Flashduty Terraform Provider 支持以代码方式管理 12 类资源和 13 类数据源：

**资源（可创建和管理）：**

| 资源                         | 说明                      |
| -------------------------- | ----------------------- |
| `flashduty_team`           | 团队                      |
| `flashduty_member_invite`  | 成员邀请                    |
| `flashduty_channel`        | 协作空间（含告警聚合、抖动检测、自动关闭配置） |
| `flashduty_schedule`       | 值班表（支持多层轮换、时间限制）        |
| `flashduty_escalate_rule`  | 分派策略（多环节、时间过滤、告警过滤）     |
| `flashduty_silence_rule`   | 静默策略                    |
| `flashduty_inhibit_rule`   | 抑制策略                    |
| `flashduty_field`          | 自定义字段                   |
| `flashduty_route`          | 告警路由                    |
| `flashduty_template`       | 通知模板                    |
| `flashduty_alert_pipeline` | 告警处理流水线                 |
| `flashduty_incident`       | 故障                      |

**数据源（可查询）：** 支持按 ID 或名称查询团队、协作空间、成员、自定义字段、通知模板和路由配置。

<Tip>
  访问 [Terraform Registry](https://registry.terraform.io/providers/flashcatcloud/flashduty/latest/docs) 查看完整的资源属性和使用示例。
</Tip>