Skip to content

Add MCP connector docs, features page, and new guides - #6

Open
rakesh-snippyly wants to merge 4 commits into
mainfrom
claude/superflow-portal-docs-78gpp8
Open

Add MCP connector docs, features page, and new guides#6
rakesh-snippyly wants to merge 4 commits into
mainfrom
claude/superflow-portal-docs-78gpp8

Conversation

@rakesh-snippyly

Copy link
Copy Markdown
Contributor

Summary

This PR significantly expands the documentation with new sections for the Model Context Protocol (MCP) connector, a comprehensive features overview page, and several new how-to guides. It also updates existing documentation for clarity and adds new billing/security pages.

Key Changes

New MCP Documentation

  • Added complete MCP connector overview explaining how to connect AI tools (Claude, ChatGPT, Cursor, Gemini) to Superflow
  • Added MCP tool reference documenting all 20+ available tools and their permissions
  • Added setup guides for Claude (claude.ai, Claude Code, Claude API), ChatGPT, Cursor, and Gemini/other clients
  • Documented OAuth-based access control and permission model

New Feature & Product Pages

  • Added comprehensive "Top Features" page mapping all Superflow capabilities with links to detailed guides
  • Added "Team Users and Guests" page explaining workspace roles and seat types
  • Added "Comment Screenshots" page documenting screenshot capture modes (Basic vs. Local)
  • Added "Workspace Agent" page explaining the built-in team checklist agent

New How-To Guides

  • Added "How to Review Agent Findings" guide for viewing agent check results
  • Added "How to Use Custom Comment Statuses" guide for workflow customization
  • Added "How to View Analytics" guide for tracking team metrics
  • Added "How to Use Versions and Approve a File" guide for file management
  • Added "How to Archive or Delete a Project" guide for project lifecycle
  • Added "How to Set Up Email Summaries" guide for notifications
  • Added "How to Import Designs from Figma" guide for design review workflow
  • Updated "How to Export Comments" with actual implementation details

API & Integration Documentation

  • Added REST API overview page with authentication and conventions
  • Updated Create Project endpoint with new parameters (scriptAlreadyInstalled, runAgentChecks, agentIds)
  • Updated auth tokens documentation with clearer structure and examples
  • Extended webhook documentation with configuration reference section

Documentation Structure

  • Updated docs.json navigation to include new pages and reorganize sections
  • Added 20+ supporting images for new guides and features
  • Removed outdated "How to Add an Arrow Comment" guide

Notable Implementation Details

  • MCP connector uses OAuth 2.1 with dynamic client registration for secure per-user access
  • REST API now supports automatic agent runs on project creation with configurable agent selection
  • Custom comment statuses feature available on paid plans with visual workflow representation
  • Analytics page provides team-wide and individual queue views with resolution time metrics

https://claude.ai/code/session_01E4yAQqf7quaZwa78vdxeaV

claude added 3 commits August 14, 2026 17:36
…files, roles

- New Top Features overview page
- Workspace Agent and agent-findings guides
- AI credits, analytics, custom statuses, email summaries, archive/delete guides
- Figma import and file version approval guides
- Team Users vs Guests roles page, comment screenshots page, SAML SSO page
- Rewrite export-comments page (feature now exists: JSON/CSV export)
- Expand auth-tokens page with header reference
- Remove arrow-comment guide (arrow tool removed from the toolbar)
- Draft MCP client setup pages (Claude, ChatGPT, Cursor, Gemini)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E4yAQqf7quaZwa78vdxeaV
… wiring

- MCP: overview with permissions and demo endpoint, full 22-tool reference,
  and refined Claude API setup with the mcp_toolset and beta flag
- REST APIs: new overview page (auth headers, envelope conventions);
  create-project updated with scriptAlreadyInstalled, runAgentChecks,
  agentIds and the agentChecks response block plus an error table
- Webhooks: add configuration reference (dual URLs, Basic auth header,
  event catalog, encode/encrypt options)
- Wire all new pages into docs.json navigation, add arrow-page redirect,
  update README structure table

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E4yAQqf7quaZwa78vdxeaV
Captured from the portal running against its hermetic e2e stack (seeded
demo data, no real accounts) and from the public demo site for the
toolbar. Covers the Workspace Agent, AI credits, analytics, custom
statuses, email summaries, archiving, user roles, comment screenshots,
auth tokens, comment export and the Top Features toolbar shots.

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

mintlify Bot commented Aug 14, 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 14, 2026, 6:55 PM

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

Rewrites the guides that still described the previous portal (WEBSITES and
PREFERENCES modules, the old create-project wizard) to match today's
product, with fresh captures from the running app and the live demo site:

- Create project: the New Project page, agent pre-checks, platform install
  cards with live preview, auto-verify, invite step
- Project settings: current section list (access control, domains, export,
  danger zone) reached from the row menu
- Kanban board and view-all-comments: current board, filters, focus mode
- Invites: Team User and Guest terminology, the current invite dialog,
  removal flows and seat notes
- Custom branding: the Settings tab with Toolbar and Admin Portal uploads
- Webhooks and Slack: current Settings > Integrations navigation
- Toolbar guides: sign in, collapse and expand, comment mode, enter and
  exit review mode, open in mobile, view dashboard, all with current
  toolbar captures

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E4yAQqf7quaZwa78vdxeaV
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