[docs-scanner] Confusing explanation of approval-required outcome vs permit in MCP policy

Offen Anfängerfreundlich
#26,560 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
88/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Bereich
documentation

Rechercherichtung

Öffne content/manuals/ai/governance/reference/mcp-policy.md und lies den Abschnitt „Approval annotation“. Stelle klar, dass @requireApproval ein permit kennzeichnet und vor der Zulassung der Anfrage eine Bestätigung erfordert; achte darauf, dass die Formulierung mit dem dort beschriebenen Richtlinienverhalten übereinstimmt. Die Aufgabe ist erledigt, wenn Leser erkennen können, dass ein Ergebnis mit erforderlicher Bestätigung ein gekennzeichnetes Permit und kein separates, konkurrierendes Ergebnis ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

File: content/manuals/ai/governance/reference/mcp-policy.md

Issue

The "Approval annotation" section states:

An approval-required outcome takes precedence over a normal permit.

This phrasing is confusing because an approval-required outcome IS a type of permit (specifically, a permit with the @requireApproval annotation). The statement makes it sound like there are two separate, competing outcomes when in fact the approval-required outcome is just a modified permit.

Why this matters

Readers trying to understand the evaluation model will be confused about whether approval-required is a distinct decision type or a variant of permit. The current phrasing suggests they're different things that can conflict, when actually an annotated permit simply requires an extra step before allowing the request.

Suggested fix

Rewrite to clarify the relationship. For example:

When a request matches a permit annotated with @requireApproval and no forbid overrides it, the policy engine returns an approval-required outcome instead of immediately allowing the request. The annotation string is shown as the elicitation reason.

Or:

A permit with @requireApproval requires user confirmation before allowing the request. This approval-required behavior takes precedence over a plain permit without the annotation.


Found by nightly documentation quality scanner

Vorherrschende Sprache
Markdown
Sterne
4.7k
Forks
8.5k
Ø Merge
2 T. 13 Std.
Gemergte PRs (30 T.)
139

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus docker/docs

Alle Issues in docker/docs

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.