[docs-scanner] Contradictory information about MCP approval fields in audit records

Aperta Adatta ai principianti
  • Qualcosa non va?
#26,559 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Leggi content/manuals/ai/governance/reference/audit-records.md, concentrandoti sulla sezione “Approval fields” e sulla relativa tabella. Chiarisci quali campi si applicano alle approvazioni di rete e quali alle approvazioni MCP, mantenendo le descrizioni coerenti con il testo. Il lavoro è completato quando i lettori possono capire quali campi aspettarsi per ciascun tipo di approvazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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 with AUDIT_DECISION_APPROVAL_DENY. Neither record includes approval.approval_request_id or approval.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

Lingua principale
Markdown
Stelle
4.7k
Fork
8.5k
Merge medio
2g 13h
PR unite (30g)
139

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di docker/docs

Tutte le issue di docker/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.