Skip to content

docs: add "type": "http" to the .mcp.json example - #1734

Closed
Dhairya-007 wants to merge 3 commits into
open-circle:mainfrom
Dhairya-007:doc-mcp-json-type-http
Closed

Dhairya-007 wants to merge 3 commits into
open-circle:mainfrom
Dhairya-007:doc-mcp-json-type-http

Conversation

@Dhairya-007

@Dhairya-007 Dhairya-007 commented Nov 4, 2026 •

Copy link
Copy Markdown

Closes #1564.

Adds "type": "http" to the .mcp.json example on the Coding agents guide.

Why it's needed

I checked this against the current Claude Code MCP docs rather than going on the original report alone. For a URL-based entry the field isn't just recommended, it's required: an entry that has a url but no type is read as a stdio server, so Claude Code skips it and reports

MCP server "valibot" has a "url" but no "type"; add "type": "http" (or "sse" / "ws") to this entry

That also lines up with the claude mcp add --transport http ... command directly above the JSON block, which writes the type field for you — so the two snippets on the page disagreed.

Changes

  1. "type": "http" added to the JSON example.
  2. The sentence introducing the block named only Cursor, so I added Claude Code's .mcp.json — that's the config this fix matters for.
  3. Added myself to the page contributors, per the convention on the other guide pages.

Three small commits rather than padding it out, since the actual fix is one line.

Notes

  • "streamable-http" is accepted as an alias, but "http" is what the docs use and matches the CLI flag.
  • Harmless for Cursor, which already accepts an explicit transport field alongside url.
  • Prettier reports no formatting change on the file (I ran it with --parser mdx; the repo config pulls in @trivago/prettier-plugin-sort-imports, which isn't needed for MDX).

Docs-only — no library code touched.

Summary by CodeRabbit

  • Documentation
    • Added Dhairya-007 to the contributors list.
    • Clarified that Claude Code uses JSON configuration for MCP setup.

Without it Claude Code treats the entry as a stdio server, since it
only infers the transport from "type", and the server never connects.
Matches the --transport http flag used by the CLI command above.

Closes open-circle#1564
The JSON block is the one Claude Code users need, but the sentence
above it only named Cursor.
@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The coding agents guide adds Dhairya-007 to its contributor list and updates its JSON configuration instructions to mention Claude Code’s .mcp.json. The existing configuration example remains unchanged.

Possibly related PRs

  • open-circle/valibot#1725: Updates the same guide’s MCP configuration instructions for Claude Code, using a separate example.

Suggested reviewers: fabian-hiller

Merge Risk: Minimal · up to 699a9

The guide now includes the HTTP transport field required for the documented Claude Code setup. This documentation-only change is ready to merge after normal checks.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the change accurately: it adds a "type": "http" field to the .mcp.json example in the Coding agents guide. The raw summary confirms that the MCP setup text now lists Claude Code's .mcp…
Linked Issues check Passed Issue #1564 requires "type": "http" in the JSON-based MCP example. The diff adds this field to the valibot entry in website/src/routes/guides/(get-started)/coding-agents/index.mdx. The guide now…
Out of Scope Changes check Passed The diff changes only the linked MCP documentation example, its introductory sentence, and the page contributor list. The sentence clarifies the affected tool, and the contributor entry follows the pa…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Full details: Title check

Explanation

The title names the change accurately: it adds a "type": "http" field to the .mcp.json example in the Coding agents guide. The raw summary confirms that the MCP setup text now lists Claude Code's .mcp.json among JSON-configured tools and that the example includes the type field. The objectives say the field is needed for URL-based MCP entries in Claude Code. The title covers the main change, though it omits the Claude Code wording change and the contributors entry. Those are secondary, so the title passes.

Full details: Linked Issues check

Explanation

Issue #1564 requires "type": "http" in the JSON-based MCP example. The diff adds this field to the valibot entry in website/src/routes/guides/(get-started)/coding-agents/index.mdx. The guide now identifies Claude Code as a user of the example. This implements the linked issue requirement.

Full details: Out of Scope Changes check

Explanation

The diff changes only the linked MCP documentation example, its introductory sentence, and the page contributor list. The sentence clarifies the affected tool, and the contributor entry follows the page convention. No unrelated library or product code changes are present.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

⚠️ This pull request has been flagged as potential spam (contributor-gaming) by CodeRabbit slop detection and should be reviewed carefully.

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
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 6cb7a902-b4bf-4fc8-aec2-c2d0401cb45a
Commits

Reviewing files that changed from the base of the PR and between d72f76f and 699a9e3.

Files selected for processing: 1
  • website/src/routes/guides/(get-started)/coding-agents/index.mdx

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@cubic-dev-ai cubic-dev-ai 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.

No issues found across 1 file

Re-trigger cubic

@Dhairya-007

Copy link
Copy Markdown
Author

Withdrawing this — #1725 covers the same .mcp.json "type": "http" guidance for the same page and was opened first, so please close this one in its favour.

The only difference is placement: #1725 adds a separate block for the project-level file, this one amended the existing Cursor example. Either reads fine, and #1725 has priority.

@Dhairya-007 Dhairya-007 closed this Nov 8, 2026
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.

docs: add "type": "http" to .mcp.json example

1 participant