Polish Avo MCP overview docs for catalog submission#1706
Closed
thoragudf wants to merge 6 commits into
Closed
Conversation
Adds example session blocks for the three major flows (find events, create property, open branch) with sample JSON responses for search, get, workflow, and save_items so reviewers can see what success looks like. Adds Troubleshooting and Support/privacy sections to cover the catalog policy items not yet addressed in the page. Closes AVO-2879. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Member
📝 Changed routes:
|
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThe PR expands the Avo MCP overview documentation with practical example sessions demonstrating typical user workflows, a troubleshooting guide addressing common issues, and support/privacy information. All changes are additive documentation in a single MDX file. ChangesAvo MCP overview documentation expansion
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
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)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Replaces the two primitive example sessions (create a property, open a branch) with two flagship ones that demonstrate the connector's actual value: - Design tracking for a new feature — audit-rules lookup, both-lenses recon, branch creation, batched save_items with tempId cross-refs. - Review and implement a branch in code — list_branches, get_branch_implementation_guide, get_sources, get_branch_code_snippets. The Discovery example (search → get) stays. Net result: three Example sessions on the same overview page, each showing end-to-end value, with sample JSON for every tool call. The primitive workflow/save_items calls still appear inside the bigger flows. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replaces the two parallel sections (high-level flow lists + dense end-to-end transcripts) with a single Example workflows section. Each flow now has both a paragraph of context and a concrete example in one place, instead of being described twice. Format trimmed: drop the Server-arrow framing, narrate request calls in prose, keep JSON only for response shapes that show what success looks like. The Smart Search callout moves to the Discovery flow where it belongs semantically. Net effect: page drops from 443 to 317 lines, no functional content removed. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Pull workflow examples out of plain-text fences so prose renders as markdown (bold User/Claude labels, **emphasis**, list bullets, inline code), with only JSON response samples wrapped in fenced code blocks. - End the Example workflows section with a pointer to the Tools reference — these three flows are not exhaustive. - Move Tools so it follows Example workflows; move Troubleshooting after Tools; move Support and privacy to the bottom of the page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Rewrite What you can do as 6 one-line user outcomes (matching Notion's use-case style) instead of read/write capability bullets. Replace the ~170-line Example workflows section with a single ~50-line Example block covering search and save_items — the two tools the original ticket flagged and the two a catalog reviewer is most likely to test. JSON-only fenced blocks with the request as a comment header; no conversational narration. Page drops from 311 to 192 lines. Section order unchanged from prior pass: What you can do → Capability matrix → Setup → Authentication → Getting started → Example → Tools → Troubleshooting → Support and privacy. Still satisfies catalog policy §3.A, §3.B, §3.C, §3.E. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The Example section on the overview leaked implementation detail (tool names in a section title) and meta-commentary into user-facing docs. Exemplar overviews (Linear, Stripe, Notion) don't put JSON dumps on the overview at all — response samples belong on the tool reference page next to each tool definition. - Remove "Example: search and save_items" section from overview - Add sample JSON responses to tools.mdx next to the search and save_items entries - Drop the trailing scope meta-line from "What you can do" — the capability matrix immediately below already shows scopes per tool Overview drops from 192 to 137 lines and now reads as scannable reference material. Closes the ticket's "sample JSON response" ask via the tool reference, where it belongs canonically. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
pages/reference/avo-mcp/overview.mdx— find events by meaning, create a property on a branch, open a new branch — with the user prompt, the tool calls Claude makes, and sample JSON responses. Sample responses coversearch,get,workflow, andsave_itemsso reviewers can see what success looks like.branchName,NotYetImplemented, headless OAuth, workspace access).Together these close the gaps against the Anthropic Software Directory Policy §3.A (privacy link), §3.B (support channel), §3.C (troubleshooting), and §3.E (three working example use cases).
Closes AVO-2879.
Test plan
/reference/avo-mcp/tools#save_items,/reference/avo-mcp/tools, Workspace Settings link)https://www.avo.app/l/privacy)search,get,workflow,save_items)🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation