Skip to content

docs(guides): add HyperFrames MCP guide#548

Open
jrusso1020 wants to merge 1 commit intomainfrom
docs/hyperframes-mcp
Open

docs(guides): add HyperFrames MCP guide#548
jrusso1020 wants to merge 1 commit intomainfrom
docs/hyperframes-mcp

Conversation

@jrusso1020
Copy link
Copy Markdown
Collaborator

What

Adds a new guide at docs/guides/mcp.mdx explaining the HyperFrames MCP — a hosted Model Context Protocol server that lets Claude.ai and ChatGPT users author, preview, and render HyperFrames compositions without a local install.

The page is not added to the navbar (docs.json unchanged) — it's only reachable via the direct URL /guides/mcp until the MCP launches publicly. Hardlinkable now for sharing with beta users and stakeholders.

Why

The MCP is approaching launch and we need an externally-facing reference page that:

  • Explains what the MCP does (the six tools, what they return, when each is invoked)
  • Walks users through setup in Claude.ai and ChatGPT
  • Provides self-serve debugging — MCP Inspector usage, progress notifications, common-issue accordion, issue reporting
  • Covers limitations honestly (cloud-only, single-user, no binary uploads, etc.)
  • Clarifies how the hosted MCP relates to the open-source HyperFrames CLI (so users pick the right tool)

Modeled after Gamma's MCP doc structure but adapted to HyperFrames patterns and the existing docs/ style (Mintlify, the conventions in DOCS_GUIDELINES.md, and patterns from claude-design.mdx / troubleshooting.mdx).

How

  • New file: docs/guides/mcp.mdx
  • No changes to docs.json — page is hardlinkable but doesn't appear in the sidebar
  • Beta callout at the top so users know features and pricing may change pre-launch
  • Tabbed setup (Claude.ai / ChatGPT), tool reference table + per-tool detail, prompting tips with a less-effective-vs-more-effective comparison, debugging section with MCP Inspector + 7-issue troubleshooting accordion, limitations section, OSS-vs-MCP comparison, and a Next steps card group

Test plan

  • File created at docs/guides/mcp.mdx with valid Mintlify frontmatter
  • docs.json unchanged — page does not appear in navbar
  • bunx oxfmt --check and bunx oxlint skip .mdx (matches existing guide convention — JS/TS-only tooling)
  • commitlint passed on conventional commit
  • Reviewer to verify rendering in Mintlify dev preview locally and that the URL /guides/mcp resolves
  • Reviewer to confirm tone, accuracy of tool descriptions, and that the OSS-vs-hosted-MCP framing reads correctly

Adds a hardlinkable doc at /guides/mcp covering setup, available
tools, prompting tips, and debugging for the HyperFrames MCP.
Not added to docs.json navigation yet — accessible via direct URL
only until the MCP launches.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Apr 29, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hyperframes 🟢 Ready View Preview Apr 29, 2026, 2:39 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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