Skip to content

Recommend Streamable HTTP and clarify CLI MCP and skills setup - #1401

Open
chris-garber-vapi wants to merge 2 commits into
mainfrom
codex/update-mcp-docs
Open

chris-garber-vapi wants to merge 2 commits into
mainfrom
codex/update-mcp-docs

Conversation

@chris-garber-vapi

Copy link
Copy Markdown

Description

  • Recommend Streamable HTTP and the v2 endpoint; remove legacy SSE setup tabs, client examples, and the external MCP tool's SSE configuration example.
  • Explain that vapi mcp setup configures the authenticated v2 connection, while vapi skills setup installs public agent skills. Document generated configuration, key handling, supported IDE paths, status checks, and migration from the legacy local docs package.
  • Treat the CLI commands as released. Documentation querying remains planned through v2; no standalone docs setup command is recommended.

Companion CLI change: VapiAI/cli #19.

Testing Steps

  • Fern 5.151.1 local validation: 0 errors, 15 warnings.
  • Parse all 7 JSON examples and syntax-check both JavaScript examples across the 5 changed pages.
  • git diff --check.
  • Inspect the CI-generated documentation preview.

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

@scott-lowe-vapi scott-lowe-vapi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Setup instructions match CLI #19. All seven JSON examples parse and both JavaScript examples pass syntax checks. Publish after the CLI commands are released.

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