[docs-scanner] Confusing explanation of approval-required outcome vs permit in MCP policy
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
- Área
- documentation
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
permitannotated with@requireApprovaland noforbidoverrides 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
permitwith@requireApprovalrequires user confirmation before allowing the request. This approval-required behavior takes precedence over a plainpermitwithout 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
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de docker/docs
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
status/triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
[docs-scanner] Unclear policy change timing in organization policies overviewPosiblemente ocupada @Mhdomer la tomó hoy. Abierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 89/100
Los mantenedores suelen responder en 1 día
-
[docs-scanner] Unclear pronoun reference in cloud delivery notePosiblemente ocupada @craig-osterhout la tomó hace 1 día. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 94/100
docker/docs#26547 · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
Debian installation pitfallPosiblemente ocupada @Duo-ee la tomó hace 6 días. Abiertostatus/triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día
Todos los issues de docker/docs
Issues similares
-
Blog update untriaged
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
-
sync-en
Dificultad 1/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
fix(docs): align git__gh troubleshooting with its actual failure pathsPosiblemente ocupada @akhil9tiet la tomó hoy. Abiertobug docs p2
Dificultad 1/5 1-3 horas Aptitud para principiantes 78/100
vercel/eve#6130 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
cutover-blocker documentation v2-migration
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
disnog/netranger-db#11 · 1 comentario ·