[docs-scanner] Confusing explanation of approval-required outcome vs permit in MCP policy
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 1/5
- Tempo estimado
- Menos de uma hora
- Facilidade para iniciantes
- 88/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Domínio
- documentation
Direção de pesquisa
Abra content/manuals/ai/governance/reference/mcp-policy.md e leia a seção “Approval annotation”. Esclareça que @requireApproval anota um permit e exige confirmação antes de permitir a solicitação; mantenha a redação consistente com o comportamento da política descrito ali. O trabalho estará concluído quando os leitores puderem entender que um resultado que exige aprovação é um permit anotado, e não um resultado separado e concorrente.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
- Linguagem predominante
- Markdown
- Estrelas
- 4.7k
- Forks
- 8.5k
- Merge médio
- 2d 13h
- PRs com merge (30d)
- 139
Preparar o ambiente
- Inclui um Dockerfile ou arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de docker/docs
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 88/100
Mantenedores costumam responder em até 1 dia
-
status/triage
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 68/100
Mantenedores costumam responder em até 1 dia
-
[docs-scanner] Unclear policy change timing in organization policies overviewTalvez já em andamento @Mhdomer assumiu hoje. Aberta
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 89/100
Mantenedores costumam responder em até 1 dia
-
[docs-scanner] Unclear pronoun reference in cloud delivery noteTalvez já em andamento @craig-osterhout assumiu há 1 dia. Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 94/100
docker/docs#26547 · 1 responsável ·
Mantenedores costumam responder em até 1 dia
-
Debian installation pitfallTalvez já em andamento @Duo-ee assumiu há 7 dias. Abertastatus/triage
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
Mantenedores costumam responder em até 1 dia
Todas as issues de docker/docs
Issues semelhantes
-
Blog update untriaged
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
-
sync-en
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 82/100
Mantenedores costumam responder em até 1 dia
-
documentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
fix(docs): align git__gh troubleshooting with its actual failure pathsTalvez já em andamento @akhil9tiet assumiu hoje. Abertabug docs p2
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 78/100
vercel/eve#6130 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
cutover-blocker documentation v2-migration
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
disnog/netranger-db#11 · 1 comentário ·