docs(mcp,a2a): document phase 0/2a feature surfaces in READMEs - #54
Conversation
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.
📝 WalkthroughWalkthroughDocumentation updates expand CLI flag documentation in Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 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
📒 Files selected for processing (2)
a2a/README.mdmcp/README.md
Summary
Pure docs — no code changes.
Test plan
Summary by CodeRabbit
Release Notes