Skip to content

Commit 48cb3bc

Browse files
authored
Merge pull request #151 from flashcatcloud/doc-review/2026-07-09-031723
docs: sync doc-review updates
2 parents aac5114 + c383583 commit 48cb3bc

4 files changed

Lines changed: 66 additions & 6 deletions

File tree

en/ai-sre/sessions.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,17 @@ Dimensions available in the filter panel:
4848

4949
The panel footer provides **Reset** (restore default filters) and **Done** (close the panel).
5050

51+
### Session Visibility and Permissions
52+
53+
The account is the hard access boundary for sessions: sessions are never accessible across accounts. Within the same account, personal sessions and team sessions use different rules for reading, continuing, and managing the conversation:
54+
55+
| Session type | Can read / continue the conversation | Can rename, archive, delete, or attach an incident |
56+
|---|---|---|
57+
| Personal session (no team bound) | Only the creator | Only the creator |
58+
| Team session (team bound) | Members in the same account who have the session ID | Session creator, account owner / admin, or members of the bound team |
59+
60+
Pinning is a personal preference and does not modify the session itself; if you can read a session, you can pin or unpin it for yourself. Account owners and admins can manage team sessions, but they cannot read or manage another member's personal session.
61+
5162
### Per-Session Actions
5263

5364
Hover over a session row to reveal the pin and archive actions. A pinned session displays a persistent pin icon to the left of its name.
@@ -285,7 +296,7 @@ The response `Content-Type` is `application/x-ndjson`. The **first line is alway
285296
If an error occurs after streaming has already begun, the server cannot switch to a standard JSON error envelope. Instead, a JSON-encoded error object is appended as the final line of the stream. Consumers must inspect this last line to determine whether the stream completed successfully.
286297
</Warning>
287298

288-
**Permissions**: the export endpoint uses the same access gate as sending messages (`CanChatSession`), meaning the caller must have message-send permission on the session — read-only access is not sufficient.
299+
**Permissions**: the export endpoint uses the same access gate as sending messages (`CanChatSession`), meaning the caller must have message-send permission on the session — read-only access is not sufficient. Personal sessions can be exported only by their creator; team sessions can be exported by same-account members who can access the session.
289300

290301
## Related Pages
291302

en/developer/mcp-server.mdx

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: ["MCP", "Model Context Protocol", "AI", "Claude", "Cursor", "Flashduty
88
Flashduty MCP Server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that connects the Flashduty API seamlessly into MCP-capable AI tools (such as Cursor and Claude Desktop). With it, you can let an LLM query, acknowledge, and close incidents, retrieve channels and members, and validate notification templates directly — embedding incident management and automation into your AI workflow.
99

1010
<Info>
11-
Flashduty MCP Server is built on the [go-flashduty SDK](/en/developer/go-sdk); every tool is a thin wrapper over the Flashduty Open API.
11+
Flashduty MCP Server provides a curated, task-oriented toolset; it does not mirror the full Flashduty Open API. For 1:1 coverage of every Open API operation, use the [Flashduty CLI](/en/developer/cli); agents with shell access can call the CLI directly.
1212
</Info>
1313

1414
## Use cases
@@ -224,6 +224,21 @@ The server provides **8 toolsets and 23 tools** in total, all enabled by default
224224
Toolset names (`incidents`, `status_page`, etc.) are internal program identifiers; keep them in English when configuring.
225225
</Note>
226226

227+
### Pagination Parameters
228+
229+
List-style query tools use one shared pagination contract: `limit` is the number of items per page, default `20`, max `100`; `page` is a 1-based page number, default `1`. When more results remain, the response includes `truncated: true` and a `hint` that names the next page to request, such as `page:2`.
230+
231+
The following tools support `limit` / `page`:
232+
233+
| Tool | Pagination behavior |
234+
|---|---|
235+
| `query_incidents` | Normal list queries use `limit` / `page`; direct lookup with `incident_ids` ignores other filters and does not page |
236+
| `query_incident_alerts` | `page` applies to every requested incident's alert list; when one incident still has more alerts, that incident entry carries `truncated` and `hint` |
237+
| `query_channels` | Name search and `channel_ids` filtering use the same paginated list endpoint, so both support `limit` / `page` |
238+
| `query_members` | Name or email search supports pagination; direct lookup with `person_ids` returns the requested members and does not page |
239+
| `query_teams` | Name search supports pagination; direct lookup with `team_ids` returns the requested teams and does not page |
240+
| `query_changes` | Normal filtered queries support pagination; with `change_ids`, the tool filters the current page client-side, reports the matched count, and does not add a pagination hint |
241+
227242
The tools in each toolset are as follows:
228243

229244
<AccordionGroup>
@@ -251,7 +266,8 @@ The tools in each toolset are as follows:
251266
| `severity` | string | Filter by severity: `Info`, `Warning`, `Critical`. |
252267
| `channel_ids` | string | Comma-separated channel IDs. |
253268
| `query` | string | Free-text search across title, labels, and content. |
254-
| `limit` | number | Number of results to return. Default 20, max 100. |
269+
| `limit` | number | Number of results per page. Default 20, max 100. |
270+
| `page` | number | 1-based page number; when the response includes `truncated: true`, follow the `hint` to request the next page. |
255271

256272
**`since` / `until` time-window behavior**
257273

@@ -320,6 +336,9 @@ The tools in each toolset are as follows:
320336
<Card title="go-flashduty SDK" icon="code" href="/en/developer/go-sdk">
321337
The Go SDK that MCP Server depends on, covering the entire Flashduty Open API.
322338
</Card>
339+
<Card title="Flashduty CLI" icon="terminal" href="/en/developer/cli">
340+
Command-line tool covering the Flashduty Open API, useful when an agent needs complete API coverage.
341+
</Card>
323342
<Card title="GitHub repository" icon="rocket" href="https://github.com/flashcatcloud/flashduty-mcp-server">
324343
Browse the source, releases, and issue tracker.
325344
</Card>

zh/ai-sre/sessions.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,17 @@ sidebarTitle: 控制台
4848

4949
面板底部提供 **重置**(恢复默认筛选)与 **完成**(关闭面板)。
5050

51+
### 会话可见性与操作权限
52+
53+
会话以账户为硬边界,跨账户永远不可访问。在同一账户内,个人会话和团队会话的读取、继续对话与管理权限不同:
54+
55+
| 会话类型 | 可读取 / 继续对话 | 可重命名、归档、删除或关联故障 |
56+
|---|---|---|
57+
| 个人会话(未绑定团队) | 仅创建者本人 | 仅创建者本人 |
58+
| 团队会话(绑定团队) | 同账户内拿到会话 ID 的成员 | 会话创建者、账户 Owner / 管理员、或该团队成员 |
59+
60+
置顶是个人偏好,不会修改会话本身;只要您有权读取这条会话,就可以为自己置顶或取消置顶。账户 Owner / 管理员可以管理团队会话,但不能读取或管理其他成员的个人会话。
61+
5162
### 单条会话操作
5263

5364
将鼠标悬停在会话行上,会显示置顶与归档操作;置顶的会话在名称左侧常驻一个图钉标记。
@@ -285,7 +296,7 @@ Fork 会话会清理只属于运行中的临时状态,例如当前回合缓存
285296
若流式传输已开始后发生错误,服务器**无法**切换回标准 JSON 错误包。此时会在流末尾追加一行 JSON 编码的错误对象,消费方需检测该行以判断流是否完整。
286297
</Warning>
287298

288-
**权限**:导出端点使用与发送消息相同的权限门控(`CanChatSession`),即要求调用方具备该会话的消息收发权限,单纯的只读访问权限不够。
299+
**权限**:导出端点使用与发送消息相同的权限门控(`CanChatSession`),即要求调用方具备该会话的消息收发权限,单纯的只读访问权限不够。个人会话只能由创建者导出;团队会话可由同账户内具备会话访问能力的成员导出。
289300

290301
## 相关页面
291302

zh/developer/mcp-server.mdx

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: ["MCP", "Model Context Protocol", "AI", "Claude", "Cursor", "Flashduty
88
Flashduty MCP Server 是一个 [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) 服务端,将 Flashduty API 无缝接入支持 MCP 的 AI 工具(如 Cursor、Claude Desktop)。借助它,您可以让大模型直接查询故障、确认与关闭故障、检索协作空间与成员、校验通知模板,把故障管理与自动化能力嵌入 AI 工作流。
99

1010
<Info>
11-
Flashduty MCP Server 底层基于 [go-flashduty SDK](/zh/developer/go-sdk) 实现,所有工具均是对 Flashduty 开放 API 的薄封装
11+
Flashduty MCP Server 提供的是经过整理的任务型工具集,并不完整镜像 Flashduty 开放 API。需要 1:1 覆盖全部开放 API 时,请使用 [Flashduty CLI](/zh/developer/cli);具备 shell 权限的 Agent 也可以直接调用 CLI
1212
</Info>
1313

1414
## 适用场景
@@ -224,6 +224,21 @@ docker run -i --rm \
224224
工具集名称(`incidents``status_page` 等)为程序内部标识,配置时请保持英文原样。
225225
</Note>
226226

227+
### 分页参数
228+
229+
列表型查询工具使用统一分页规则:`limit` 表示每页数量,默认 `20`,最大 `100``page` 表示从 `1` 开始的页码,默认 `1`。当返回结果还没有取完时,响应会包含 `truncated: true``hint`,其中会明确提示下一次请求应传入的页码,例如 `page:2`
230+
231+
支持 `limit` / `page` 的工具包括:
232+
233+
| 工具 | 分页行为 |
234+
|---|---|
235+
| `query_incidents` | 普通列表查询按 `limit` / `page` 翻页;使用 `incident_ids` 直接查找时忽略其他过滤条件,不走分页 |
236+
| `query_incident_alerts` | `page` 会应用到每个指定故障的告警列表;某个故障仍有更多告警时,该故障结果内会带 `truncated``hint` |
237+
| `query_channels` | 名称搜索和 `channel_ids` 过滤都走同一个分页列表接口,因此都支持 `limit` / `page` |
238+
| `query_members` | 按名称或邮箱搜索时支持分页;使用 `person_ids` 直接查找时返回指定成员,不走分页 |
239+
| `query_teams` | 按名称搜索时支持分页;使用 `team_ids` 直接查找时返回指定团队,不走分页 |
240+
| `query_changes` | 普通过滤查询支持分页;使用 `change_ids` 时会在当前页内做客户端过滤,并返回匹配数量,不追加分页提示 |
241+
227242
各工具集包含的工具如下:
228243

229244
<AccordionGroup>
@@ -251,7 +266,8 @@ docker run -i --rm \
251266
| `severity` | string | 按严重程度过滤,可选:`Info``Warning``Critical`|
252267
| `channel_ids` | string | 逗号分隔的协作空间 ID。 |
253268
| `query` | string | 自由文本搜索(标题、标签、内容)。 |
254-
| `limit` | number | 返回条数,默认 20,最大 100。 |
269+
| `limit` | number | 每页返回数量,默认 20,最大 100。 |
270+
| `page` | number | 页码,从 1 开始;当响应包含 `truncated: true` 时,按 `hint` 提示请求下一页。 |
255271

256272
**`since` / `until` 时间窗口行为**
257273

@@ -320,6 +336,9 @@ docker run -i --rm \
320336
<Card title="go-flashduty SDK" icon="code" href="/zh/developer/go-sdk">
321337
MCP Server 底层依赖的 Go SDK,覆盖 Flashduty 全部开放 API。
322338
</Card>
339+
<Card title="Flashduty CLI" icon="terminal" href="/zh/developer/cli">
340+
覆盖 Flashduty 开放 API 的命令行工具,适合需要完整 API 能力的 Agent。
341+
</Card>
323342
<Card title="GitHub 仓库" icon="rocket" href="https://github.com/flashcatcloud/flashduty-mcp-server">
324343
查看源码、Release 与问题反馈。
325344
</Card>

0 commit comments

Comments
 (0)