Skip to content

Rewrite introduction and add Superflow MCP documentation - #3

Open
rakesh-snippyly wants to merge 1 commit into
mainfrom
claude/superflow-mcp-docs-distribution-b0cixg
Open

Rewrite introduction and add Superflow MCP documentation#3
rakesh-snippyly wants to merge 1 commit into
mainfrom
claude/superflow-mcp-docs-distribution-b0cixg

Conversation

@rakesh-snippyly

Copy link
Copy Markdown
Contributor

Summary

This PR completely rewrites the introduction page to accurately describe Superflow's core features and value proposition, and adds comprehensive documentation for the new Superflow MCP (Model Context Protocol) integration that enables AI assistants to interact with Superflow.

Key Changes

Introduction Page Rewrite

  • Replaced generic documentation template with Superflow-specific content
  • Added clear description of Superflow as a review tool for websites and creative assets
  • Documented core features: in-place commenting, AI review agents, file uploads, and task tracking
  • Added "How it works" section with 4-step setup flow
  • Included installation guides for no-code platforms and web frameworks
  • Added integration options (MCP, webhooks, REST API, security)
  • Created "Key concepts" reference table explaining workspace, project, review mode, threads, agents, guest mode, and seats
  • Added "Where to go next" navigation cards

New MCP Documentation

  • mcp/overview.mdx: Main MCP documentation covering server details, connection instructions, available tools, permissions model, and demo endpoint
  • mcp/claude.mdx: Setup instructions for claude.ai, Claude Code, and Claude API
  • mcp/chatgpt.mdx: ChatGPT custom connector setup guide
  • mcp/cursor.mdx: Cursor integration with one-click install link and manual config
  • mcp/gemini.mdx: Gemini CLI configuration instructions
  • mcp/other-clients.mdx: Generic MCP client setup for any compliant client
  • mcp/troubleshooting.mdx: Comprehensive troubleshooting guide covering connection issues, sign-in problems, tool failures, and disconnection

Documentation Structure

  • Updated docs.json to add "Get Started" group with introduction
  • Added new "Superflow MCP" section with 7 pages in the navigation hierarchy

Notable Details

  • MCP documentation emphasizes the remote server URL (https://mcp.usesuperflow.ai/mcp) and OAuth 2.1 with dynamic client registration
  • Troubleshooting guide covers plan limitations, permission scopes, and asynchronous agent runs
  • All client-specific guides include workspace selection and scope approval steps
  • Demo endpoint (https://mcp.usesuperflow.ai/mcp/try) documented as read-only alternative for testing

https://claude.ai/code/session_0146D3U1CzY3QepWgWAQnKJN

Replaces the Mintlify starter content on introduction.mdx with a real
Superflow intro — what the product does, how a review works end to end,
where to install it, and the key concepts — and adds it to the navigation
under a new "Get Started" group.

Adds a "Superflow MCP" group documenting the remote MCP server at
https://mcp.usesuperflow.ai/mcp:

- overview: server details, tools, scopes, example prompts, demo endpoint
- claude: claude.ai, Claude Code, and Claude API setup
- chatgpt: custom connector setup
- cursor: install link and mcp.json setup
- gemini: Gemini CLI settings.json setup
- other-clients: connection details for any remote MCP client
- troubleshooting: connection, sign-in, and permission problems

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0146D3U1CzY3QepWgWAQnKJN
@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
superflow 🟢 Ready View Preview Aug 6, 2026, 8:56 PM

💡 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