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

Ouverte Adaptée aux débutants
#26,560 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
88/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Domaine
documentation

Piste de recherche

Ouvrez content/manuals/ai/governance/reference/mcp-policy.md et lisez la section « Approval annotation ». Précisez que @requireApproval annote un permit et exige une confirmation avant d’autoriser la requête ; veillez à ce que la formulation soit cohérente avec le comportement de la politique décrit dans cette section. Le travail est terminé lorsque les lecteurs peuvent comprendre qu’un résultat soumis à approbation est un permit annoté, et non un résultat distinct concurrent.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Markdown
Étoiles
4.7k
Forks
8.5k
Merge moyen
2 j 13 h
PR mergées (30 j)
139

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de docker/docs

Toutes les issues de docker/docs

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.