Skip to content

Add MCP Servers documentation#20660

Draft
gabcoyne wants to merge 13 commits intomainfrom
mcp-install-instructions
Draft

Add MCP Servers documentation#20660
gabcoyne wants to merge 13 commits intomainfrom
mcp-install-instructions

Conversation

@gabcoyne
Copy link
Contributor

Add comprehensive documentation for Prefect MCP servers.

Changes

New Documentation Structure

  • Add new MCP Servers tab to documentation navigation
  • Landing page with two main options:
    • Prefect Docs MCP: Documentation-only access via hosted proxy at https://docs.prefect.io/mcp
    • Prefect MCP Server: Full server with workflow monitoring, debugging, and docs access

Pages Added

  1. /v3/mcp-servers/index.mdx - Landing page with overview and card navigation
  2. /v3/mcp-servers/prefect-docs-mcp.mdx - Docs proxy configuration guide
  3. /v3/mcp-servers/prefect-mcp-server.mdx - Full MCP server installation guide

Installation Coverage

Documentation includes validated installation methods for:

  • Claude Code (marketplace + manual)
  • Cursor
  • Codex CLI
  • Gemini CLI
  • Claude Desktop
  • VS Code

What's NOT Included

  • Removed references to non-existent prefect-docs-mcp-server repository
  • Removed unvalidated installation methods (local stdio, FastMCP Cloud deployment)
  • Removed unvalidated AI assistant configurations

Testing

  • Documentation served locally via Mintlify at http://localhost:3001
  • All pages render correctly with proper navigation
  • Cards link to appropriate documentation pages

Preview

View the MCP Servers documentation at: /v3/mcp-servers


Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com

gabcoyne and others added 8 commits February 12, 2026 11:45
Restructure the MCP server documentation to provide clearer, more
accessible installation guidance with better visual hierarchy and
progressive disclosure.

Changes to docs/v3/how-to-guides/ai/use-prefect-mcp-server.mdx:
- Add "Quick Start" section with expandable accordions for each AI
  assistant showing the fastest installation path
- Add "Test your setup" section with example prompts to verify
  the connection works
- Reorganize installation into clearer hierarchy: Quick start,
  Installation options (local vs cloud), and Client configuration
- Use tabs within accordions to organize different setup methods
  (CLI vs config file, basic vs with credentials)
- Improve FastMCP Cloud deployment instructions with Steps component
- Clarify credential configuration with better structured content

Changes to docs/v3/get-started/index.mdx:
- Expand MCP server section with clear quick start examples using
  CodeGroup for Claude Code, Cursor, and generic setup
- Distinguish between full MCP server (workflow integration) and
  docs-only access (documentation search)
- Provide immediate code examples to reduce friction

These improvements follow patterns from MCP Apps and Chrome DevTools
MCP documentation, requiring less reasoning from users and providing
a clearer path from installation to verification.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add new "MCP Servers" tab to documentation with comprehensive installation
instructions for Prefect MCP Server and Prefect Docs MCP Server.

Changes:
- Add MCP Servers landing page with overview and navigation cards
- Add Prefect MCP Server documentation with installation for 9+ AI assistants
  (Claude Code, Cursor, VS Code, Cline, Codex, Gemini, JetBrains, Factory,
  Qoder/OpenCode)
- Add Prefect Docs MCP Server documentation with similar comprehensive setup
- Include prerequisites, quick start guides, and advanced configuration
- Add troubleshooting section with common issues and solutions
- Add multi-environment configuration examples
- Update docs.json navigation to include new MCP Servers tab

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove the following sections from both MCP server docs pages:
- Troubleshooting installation
- Available capabilities
- Prompting tips
- Using both MCP servers together (docs server only)
- Learn more

This streamlines the documentation and focuses on the essential installation
and configuration information.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove installation instructions for untested AI assistants and simplify
to only include the four validated clients from the original documentation:
- Claude Code
- Cursor
- Codex CLI
- Gemini CLI

Also simplified the Advanced configuration section to focus on multi-instance
setup rather than listing configuration file locations for unvalidated clients.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrections based on actual Prefect MCP server implementation:
- Remove non-existent "Prefect Docs MCP Server" (doesn't exist as separate repo)
- Documentation access is built into main Prefect MCP server via integrated docs proxy
- Remove "Local installation (stdio transport)" section (not a documented method)
- Remove "Cloud deployment (HTTP transport)" section (not validated/working)
- Simplify to only include working installation methods from Quick start section

The MCP Servers tab now accurately reflects what actually exists and works.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add CardGroup with two installation method options:
- Claude Code Plugin (marketplace installation)
- Manual Installation (for other MCP clients)

Both cards link to the main Prefect MCP Server documentation page.
Also remove broken link to non-existent prefect-docs-mcp-server repo.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Change cards from installation methods to the two main use cases:
- Prefect Docs MCP (documentation access via integrated docs proxy)
- Prefect MCP Server (instance monitoring and debugging)

Both are provided by the single Prefect MCP server but represent
distinct use cases for AI assistants.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add documentation for the docs-only MCP option using the hosted
docs proxy at https://docs.prefect.io/mcp.

Changes:
- Create new prefect-docs-mcp.mdx page with docs proxy configuration
- Update landing page cards to link to separate pages
- Add prefect-docs-mcp to navigation
- Docs proxy requires no installation, just URL configuration
- Supports Claude Desktop, Cursor, VS Code, and other MCP clients

The two options are now:
1. Prefect Docs MCP - Documentation access only via docs proxy URL
2. Prefect MCP Server - Full server with workflow monitoring + docs

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Correct the Prefect Docs MCP page to reflect the actual hosted service:
- Hosted at https://docs.prefect.io/mcp (not a separate installable package)
- Uses HTTP transport via "url" configuration parameter
- Add file paths for Claude Desktop config
- Add restart instructions for each client
- Clarify it's a hosted service with no installation needed
- Update landing page descriptions to be clearer about the difference

The docs server is a hosted HTTP MCP endpoint, not an installable server.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
gabcoyne and others added 2 commits February 13, 2026 12:27
Remove 'Hosted service' and 'Need workflow integration too?' sections
as they are unnecessary.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Add paragraph about accelerating AI-assisted development
- Emphasize real-time access to current docs vs outdated training data
- Remove 'Test your setup' section

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Implement Option A: Single source of truth with clear navigation

Changes:
- Delete duplicate /v3/mcp-servers/prefect-mcp-server.mdx
- Update MCP Servers landing page to link Prefect MCP Server card to
  existing detailed guide at /v3/how-to-guides/ai/use-prefect-mcp-server
- Update get-started page to link to both MCP Servers hub and docs guide
- Remove duplicate page from docs.json navigation

Result:
- MCP Servers tab serves as discovery/navigation hub
- Single detailed guide at /v3/how-to-guides/ai/use-prefect-mcp-server
- No broken links, no duplication
- Clear discoverability from get-started page

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Reorganize documentation to consolidate all MCP content:
- Move v3/how-to-guides/ai/use-prefect-mcp-server.mdx to
  v3/mcp-servers/prefect-mcp-server.mdx
- Remove now-empty AI section from How-to Guides navigation
- Add prefect-mcp-server page to MCP Servers tab navigation
- Update all internal links to point to new location
- Remove docs/v3/how-to-guides/ai/ directory

Result: All MCP documentation is now consolidated under the
MCP Servers tab, improving discoverability and organization.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Copy link
Collaborator

@zzstoatzz zzstoatzz left a comment

Choose a reason for hiding this comment

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

i know its a draft, but lmk what the motivation is here and i'm happy to help out


Configure your AI assistant to connect to the hosted Prefect docs MCP server at:

**Server URL**: `https://docs.prefect.io/mcp`
Copy link
Collaborator

Choose a reason for hiding this comment

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

note we've chosen not to use mintlify's hosted docs MCP because it 500s all the time, and instead we built our own and host it on horizon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments