Skip to content

Appendix B - operationId and description guidelines for MCP and AI Agent readiness#39

Open
rartych wants to merge 5 commits into
mainfrom
annex_b
Open

Appendix B - operationId and description guidelines for MCP and AI Agent readiness#39
rartych wants to merge 5 commits into
mainfrom
annex_b

Conversation

@rartych

@rartych rartych commented Jul 6, 2026

Copy link
Copy Markdown
Owner

What type of PR is this?

  • enhancement/feature

What this PR does / why we need it:

Adds Appendix B (Informative) to the CAMARA API Design Guide, providingHere is a proposed PR description based on the diff:

What type of PR is this?

  • enhancement/feature

What this PR does / why we need it:

Adds Appendix B (Informative) to the CAMARA API Design Guide, providing operationId and description guidelines for MCP and AI Agent readiness. This is the outcome of the CAMARA MCP Enablement Program – Phase 0.

The appendix covers:

  • B.1operationId naming rules: presence requirement, lowerCamelCase format, <verb><Noun>[<Qualifier>] shape, approved verb list, and forbidden verbs.
  • B.2 — Operation description completeness rules: self-contained operation descriptions for automated consumers (AI agents, MCP clients), including a proposed description template.
  • B.3 — Property description completeness rules: guidance on documenting enum values for automated consumers.

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

Appendix B is informative (non-normative). The approved verb list and operation description template are proposals subject to WG review. The operationId rules in B.1 (presence, format, forbidden verbs) are normative additions that extend section 5.7.2.

Changelog input

Add Appendix B (Informative) with `operationId` and `description` guidelines for MCP and AI Agent readiness to CAMARA API Design Guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant