Skip to content

[Safe Outputs Conformance] REQ-002: Seven safe output types lack required specification sections #17405

Description

@github-actions

Conformance Check Failure

Check ID: REQ-002
Severity: MEDIUM
Category: Specification — Safe Output Type Completeness

Problem Description

Seven safe output types defined in the specification are missing required documentation sections. The specification requires each type to have all five of these bold-formatted sections:

  1. **MCP Tool Schema**
  2. **Operational Semantics**
  3. **Configuration Parameters**
  4. **Security Requirements**
  5. **Required Permissions**

Affected Types

Type Sections Found Missing Count
noop 3 / 5 2
update_issue 1 / 5 4
close_issue 1 / 5 4
link_sub_issue 1 / 5 4
create_discussion 1 / 5 4
update_discussion 1 / 5 4
close_discussion 1 / 5 4

Affected File

  • docs/src/content/docs/reference/safe-outputs-specification.md

Current Behavior

The listed types have incomplete #### Type: (name) entries. Several types appear to have only a basic schema entry without operational semantics, security requirements, or permission definitions.

Expected Behavior

Each #### Type: section MUST contain all five required subsections so that implementers and auditors can verify conformance without consulting external sources.

Remediation Steps

This task can be assigned to a Copilot coding agent with the following steps:

  1. Locate each #### Type: (name) section in docs/src/content/docs/reference/safe-outputs-specification.md.
  2. For each type listed above, add the missing bold-headed subsections following the pattern of a fully-documented type (e.g. create_issue or add_comment).
  3. Ensure each new subsection contains substantive content — at minimum:
    • MCP Tool Schema: JSON schema for inputs/outputs
    • Operational Semantics: step-by-step description of what the handler does
    • Configuration Parameters: table of all configurable fields
    • Security Requirements: MUST/SHOULD statements about validation and access
    • Required Permissions: list of GitHub API permissions needed
  4. Run the conformance checker to confirm REQ-002 passes.

Verification

After remediation, verify the fix by running:

bash scripts/check-safe-outputs-conformance.sh 2>&1 | grep "REQ-002"

The output should show [PASS] REQ-002: All safe output types have complete documentation.

References

  • Safe Outputs Specification: docs/src/content/docs/reference/safe-outputs-specification.md
  • Conformance Checker: scripts/check-safe-outputs-conformance.sh
  • Run ID: §22250818082
  • Date: 2026-02-21

Generated by Daily Safe Outputs Conformance Checker

  • expires on Feb 22, 2026, 5:12 AM UTC

Metadata

Metadata

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions