Skip to content

docs(mcp): describe_tool, save_items item envelope, snake_case item types (AVO-3576) - #1744

Open
thoragudf wants to merge 1 commit into
mainfrom
avo-3576-mcp-describe-tool-envelope
Open

thoragudf wants to merge 1 commit into
mainfrom
avo-3576-mcp-describe-tool-envelope

Conversation

@thoragudf

@thoragudf thoragudf commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

What changed?

Brings the MCP docs in line with monorepo PR avohq/monorepo#9998 (AVO-3304, describe_tool + shrink the advertised MCP tool surface), which ships with the next mcp-server redeploy.

  • reference/avo-mcp/tools.mdx
    • New How discovery works section: connect → describe_tool() → describe_tool(tool:"save_items", type, op) → write.
    • New Item type vocabulary section: one snake_case vocabulary across search / get / save_items; camelCase forms (eventVariant, propertyBundle, groupType, workspaceConfig) documented as deprecated spellings (still accepted, will be removed).
    • New describe_tool tool section (params, per-input behaviour, error-lists-valid-values, examples with real output).
    • save_items rewritten around the item envelope {op, type, id?, name?, tempId?, fields?}: ops create/update/archive/unarchive, identity-ID table for the nine documented types, set placement rules, create-only description gating (rejected on source/destination/group_type), strict unknown-key rejection, onReviewedBranch. Fields for all nine documented item types (event, property, event_variant, property_bundle, metric, category, source, destination, group_type) taken from the live describe_tool output. Gateway and checkpoint are deliberately NOT documented — feature-flagged. Every example moved to the envelope shape. nameMappings on create+update, removeAllowedValues update-only.
    • search: snake_case itemType list incl. source/destination/group_type/journey, empty-call rejection, and a Pagination section (repeat workspaceId + all params + pageToken).
    • get: snake_case types, workspace_config takes no id, journey by id, include values.
    • workflow: all five actions (create_branch, update_branch_description, pull_main, set_source_language, import) with their parameters.
    • list_branches: pageSize clamped 1–50 (coerced, not rejected).
    • Troubleshooting: the old "NotYetImplemented" entry replaced with the contract-echo error and the "client doesn't show save_items" case.
  • reference/avo-mcp/overview.mdx: capability matrix gains describe_tool; snake_case vocabulary note; pagination note in Limits.
  • data-design/avo-tracking-plan/properties.mdx: op: "remove" → op: "archive" (remove is no longer advertised).

Source of truth: projects/mcp/src/tools/DescribeTool.res, McpItemContract.res, McpReadVocabulary.res, McpInstructions.res on monorepo main; the per-type tables were rendered from the compiled describe_tool handler.

Companion PR in the plugin repo: avohq/avo-mcp (skills + README).

Link to related task: AVO-3576

🤖 Generated with Claude Code

https://claude.ai/code/session_01D2Yd6Ua3NwyGw91p8GpHKa

@linear-code

linear-code Bot commented Sep 8, 2026

Copy link
Copy Markdown

AVO-3576

@vercel

vercel Bot commented Sep 8, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Sep 8, 2026 2:39pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 8, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: b58178df-1b82-496f-8c30-b276ad9af9d1


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

@logason

logason commented Sep 8, 2026 •

Copy link
Copy Markdown
Member

@thoragudf
thoragudf force-pushed the avo-3576-mcp-describe-tool-envelope branch from 3f5e3e8 to cc5a412 Compare September 8, 2026 14:23
@thoragudf

Copy link
Copy Markdown
Contributor Author

Replaced the branch commit: the first push was based on a stale local checkout and reverted content merged to main today (system-property presence per source, PII/custom-field bullets, journeys, give_feedback, plugin sections). The branch is now rebuilt from live main with only the AVO-3576 changes applied on top.

…s (AVO-3576)

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01D2Yd6Ua3NwyGw91p8GpHKa

This branch was successfully deployed

1 active deployment
Preview — 522c2a0c Deployed Sep 8, 2026 by vercel[bot]
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.

2 participants