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

Abierto Apto para principiantes
#26,560 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo

Línea de trabajo

Abre content/manuals/ai/governance/reference/mcp-policy.md y lee la sección “Approval annotation”. Aclara que @requireApproval marca un permit y requiere confirmación antes de permitir la solicitud; mantén la redacción coherente con el comportamiento de la política descrito allí. La tarea estará terminada cuando los lectores puedan entender que un resultado que requiere aprobación es un permit marcado, no un resultado separado que compite con él.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Markdown
Estrellas
4.7k
Forks
8.5k
Merge medio
2 d 13 h
PR fusionados (30 d)
139

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de docker/docs

Todos los issues de docker/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.