Skip to content

docs(mcp,a2a): document phase 0/2a feature surfaces in READMEs - #54

Merged
rohitg00 merged 1 commit into
mainfrom
docs/readme-phase-features
Apr 27, 2026
Merged

docs(mcp,a2a): document phase 0/2a feature surfaces in READMEs#54
rohitg00 merged 1 commit into
mainfrom
docs/readme-phase-features

Conversation

@rohitg00

@rohitg00 rohitg00 commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • a2a/README.md — CLI flags table missed the agent-identity flags shipped in phase 0. Adds `--agent-name`, `--agent-description`, `--provider-org`, `--provider-url`, `--docs-url` with defaults and the AgentProvider/documentationUrl omit-when-empty semantics.
  • mcp/README.md — adds an "MCP 2025-06-18 spec coverage" section enumerating the methods landed in phase 2a: pagination, completion/complete, logging/setLevel + notifications/message, resources/subscribe + resources/unsubscribe + notifications/resources/updated, resources/templates/list, tool annotations + outputSchema + structured content, progress + cancellation. Calls out 2b/2c (sampling/elicitation, Streamable HTTP SSE) as still outstanding.

Pure docs — no code changes.

Test plan

  • `git diff` reviewed; only README markdown touched
  • CI lint passes (READMEs only — no rust/node/python jobs to run)

Summary by CodeRabbit

Release Notes

  • Documentation
    • Expanded CLI flag documentation with new agent card metadata configuration options and conditional field behavior guidance
    • Enhanced MCP specification support documentation covering paginated lists, per-session logging, notifications, resource subscriptions, extended tool metadata, and call progress/cancellation capabilities
    • Clarified Phase 2b/2c roadmap items for future releases

a2a: add agent-identity flags (--agent-name, --agent-description,
--provider-org, --provider-url, --docs-url) shipped in phase 0 to the
CLI flags table.

mcp: document the MCP 2025-06-18 methods landed in phase 2a:
pagination, completion/complete, logging/setLevel +
notifications/message, resources/subscribe/unsubscribe +
notifications/resources/updated, resources/templates/list, tool
annotations + outputSchema, progress + cancellation. Note Phase 2b/2c
(sampling/elicitation, Streamable HTTP SSE) still outstanding.
@coderabbitai

coderabbitai Bot commented Apr 27, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Documentation updates expand CLI flag documentation in a2a/README.md for agent card metadata and conditional field behavior. mcp/README.md documentation is expanded to describe additional MCP spec support features including pagination, resource subscriptions, logging, notifications, and tool metadata.

Changes

Cohort / File(s) Summary
Agent CLI Documentation
a2a/README.md
Expanded CLI flags block documenting new options (--agent-name, --agent-description, --provider-org, --provider-url, --docs-url) and conditional behavior for omitting provider object and documentationUrl when certain flags are empty.
MCP Spec Support
mcp/README.md
New documentation section describing expanded MCP spec support beyond basic tools operations, including paginated list variants, completion, per-session logging, notifications, resource subscriptions, resource templates, tool metadata exposure, and call progress/cancellation. Clarifies Phase 2b/2c roadmap items.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A flurry of flags and specs so grand,
Docs now bloom where features stand,
MCP widens, agents take their names,
This rabbit hops through docs and frames! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: documenting phase 0/2a feature surfaces in both mcp and a2a README files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-phase-features

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
a2a/README.md (1)

49-49: Document the default value for --agent-description.

The CLI flag has a default value ("iii-engine agent — invoke any registered function via A2A") as shown in the implementation, but the documentation doesn't mention it. For consistency with other flags like --agent-name, --provider-org, etc., consider adding the default.

📝 Suggested documentation update
---agent-description <TEXT>   Agent card `description`
+--agent-description <TEXT>   Agent card `description`
+                             (default: iii-engine agent — invoke any registered function via A2A)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@a2a/README.md` at line 49, Update the README entry for the CLI flag
--agent-description to document its default value; specifically add that the
default is "iii-engine agent — invoke any registered function via A2A" alongside
the flag description so it matches other flags like --agent-name and
--provider-org and their documented defaults.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@a2a/README.md`:
- Line 49: Update the README entry for the CLI flag --agent-description to
document its default value; specifically add that the default is "iii-engine
agent — invoke any registered function via A2A" alongside the flag description
so it matches other flags like --agent-name and --provider-org and their
documented defaults.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1a009f72-a6a9-4421-8499-5d03caf17c00

📥 Commits

Reviewing files that changed from the base of the PR and between 5df3914 and c0f9221.

📒 Files selected for processing (2)
  • a2a/README.md
  • mcp/README.md

@rohitg00
rohitg00 merged commit 5504a48 into main Apr 27, 2026
9 checks passed
@rohitg00
rohitg00 deleted the docs/readme-phase-features branch April 27, 2026 10:02
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