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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#26,560 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
88/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Mở content/manuals/ai/governance/reference/mcp-policy.md và đọc phần “Approval annotation”. Làm rõ rằng @requireApproval chú thích một permit và yêu cầu xác nhận trước khi cho phép yêu cầu; giữ cách diễn đạt nhất quán với hành vi chính sách được mô tả ở đó. Hoàn tất khi người đọc có thể hiểu rằng kết quả cần phê duyệt là một permit có chú thích, không phải một kết quả riêng biệt cạnh tranh với nó.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Markdown
Star
4.7k
Fork
8.5k
Merge trung bình
2 ngày 13 giờ
Pull request đã merge (30 ngày)
139

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của docker/docs

Tất cả issue của docker/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.