[docs-scanner] Contradictory information about MCP approval fields in audit records
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 88/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- markdown
调研方向
阅读 content/manuals/ai/governance/reference/audit-records.md,重点关注“Approval fields”部分及其表格。明确哪些字段适用于网络审批,哪些字段适用于 MCP 审批,并确保描述与正文一致。完成后,读者应能判断每种审批类型对应哪些字段。
由索引模型根据 Issue 内容生成。
描述
File: content/manuals/ai/governance/reference/audit-records.md
Issue
The "Approval fields" section contains contradictory information about which fields appear in MCP approval records. The prose states:
For MCP approvals, an approved request is evaluated again and recorded with
AUDIT_DECISION_APPROVAL_ALLOW, and a declined request is recorded withAUDIT_DECISION_APPROVAL_DENY. Neither record includesapproval.approval_request_idorapproval.grant_scope.
However, the table immediately below lists:
| Field | Description |
|---|---|
approval.approval_request_id |
ID that links an approval required record to the record that resolves it. |
approval.grant_scope |
Scope the user accepted. Present only on AUDIT_DECISION_APPROVAL_ALLOW records. |
The table descriptions don't distinguish between network and MCP approvals, suggesting these fields are present on all AUDIT_DECISION_APPROVAL_ALLOW records, which contradicts the prose statement that MCP approvals don't include them.
Why this matters
A reader trying to parse MCP approval audit records will be confused about which fields to expect. If they follow the prose, they won't look for these fields. If they follow the table, they'll expect them to be present. This makes it impossible to correctly process MCP approval records.
Suggested fix
Clarify the table to indicate which fields apply to network approvals vs. MCP approvals. For example:
| Field | Description |
|---|---|
approval.approval_request_id |
ID that links an approval required record to the record that resolves it. Present for network approvals only. |
approval.grant_scope |
Scope the user accepted. Present only on network approval AUDIT_DECISION_APPROVAL_ALLOW records. |
Or restructure the section to have separate subsections for network approval fields and MCP approval fields.
Found by nightly documentation quality scanner
- 主要语言
- Markdown
- 星标
- 4.7k
- 派生
- 8.5k
- 平均合并
- 2 天 13 小时
- 30 天内合并 PR
- 139
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
docker/docs 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
-
status/triage
难度 1/5 1 小时以内 新手友好度 68/100
维护者通常 1 天内回复
-
[docs-scanner] Unclear policy change timing in organization policies overview可能已有人在做 @Mhdomer 今天认领。 未关闭
难度 1/5 1-3 小时 新手友好度 89/100
维护者通常 1 天内回复
-
[docs-scanner] Unclear pronoun reference in cloud delivery note可能已有人在做 @craig-osterhout 于 1 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 94/100
维护者通常 1 天内回复
-
Debian installation pitfall可能已有人在做 @Duo-ee 于 6 天前认领。 未关闭status/triage
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复
相似的 Issue
-
Blog update untriaged
难度 2/5 1-3 小时 新手友好度 84/100
-
sync-en
难度 1/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
documentation
难度 2/5 1-3 小时 新手友好度 78/100
-
fix(docs): align git__gh troubleshooting with its actual failure paths可能已有人在做 @akhil9tiet 今天认领。 未关闭bug docs p2
难度 1/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
cutover-blocker documentation v2-migration
难度 2/5 1-3 小时 新手友好度 75/100
disnog/netranger-db#11 · 1 条评论 ·