Skip to content

docs: move MCP deployment guide to admin docs, add user-facing AI guide#38585

Merged
eschutho merged 1 commit intoapache:masterfrom
aminghadersohi:amin/docs-iterate-mcp-docs
Mar 12, 2026
Merged

docs: move MCP deployment guide to admin docs, add user-facing AI guide#38585
eschutho merged 1 commit intoapache:masterfrom
aminghadersohi:amin/docs-iterate-mcp-docs

Conversation

@aminghadersohi
Copy link
Contributor

@aminghadersohi aminghadersohi commented Mar 11, 2026

User description

SUMMARY

Iterates on MCP documentation based on PR #38415 review feedback:

  1. Moved mcp-server.md (deployment & authentication guide) from developer_docs/extensions/ to admin_docs/configuration/ — this is operational content aimed at admins, not developer/extension content
  2. Created a new user-facing docs page: "Using AI with Superset" (docs/using-superset/using-ai-with-superset.mdx) — task-oriented guide explaining what AI can do with Superset and how to connect clients (inspired by Metabase AI docs)
  3. Updated cross-references between the three MCP docs pages (user guide, admin guide, developer guide)
  4. Removed mcp-server entry from developer sidebars

The admin sidebar auto-discovers docs from configuration/ dirName, and the user sidebar auto-discovers from using-superset/ dirName, so no sidebar config changes needed for either.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A — docs-only changes

TESTING INSTRUCTIONS

  1. Build docs: cd docs && npm run build
  2. Verify the admin sidebar shows "MCP Server Deployment & Authentication" under Configuration
  3. Verify the user sidebar shows "Using AI with Superset" under Using Superset
  4. Check cross-links resolve between the three MCP docs pages:
    • User guide → admin guide link
    • Admin guide → user guide link
    • Admin guide → developer extensions links

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

CodeAnt-AI Description

Add a user-facing "Using AI with Superset" guide and move MCP deployment docs to the admin section

What Changed

  • Added a new user-facing "Using AI with Superset" page that explains what AI can do (explore data, build charts/dashboards, run SQL), how to connect clients (Claude, ChatGPT, CLI examples), and troubleshooting tips
  • Moved the MCP Server deployment and authentication guide into the admin documentation so setup and security instructions appear under Configuration
  • Updated cross-links between the admin, developer, and user MCP pages and removed the MCP server entry from the developer docs sidebar
  • Adjusted admin doc sidebar position and updated reference links in the MCP admin guide to point to the new user guide and developer MCP integration docs

Impact

✅ Clearer admin setup for MCP deployment
✅ Users can connect AI clients with step-by-step instructions
✅ Fewer docs navigation confusions

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Move mcp-server.md from developer_docs/extensions to
admin_docs/configuration where deployment and auth content belongs.

Create a new user-facing "Using AI with Superset" page in the
Using Superset section with task-oriented guidance on what AI can
do with Superset, how to connect clients, and a tools reference.

Update cross-references between the three MCP docs pages and
remove mcp-server from developer sidebars.
@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Mar 11, 2026
@bito-code-review
Copy link
Contributor

bito-code-review bot commented Mar 11, 2026

Code Review Agent Run #fa46cf

Actionable Suggestions - 0
Review Details
  • Files reviewed - 2 · Commit Range: 54019c4..54019c4
    • docs/developer_docs/sidebars.js
    • docs/docs/using-superset/using-ai-with-superset.mdx
  • Files skipped - 0
  • Tools
    • Eslint (Linter) - ✔︎ Successful
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers a full AI review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@codeant-ai-for-open-source codeant-ai-for-open-source bot added the size:L This PR changes 100-499 lines, ignoring generated files label Mar 11, 2026
@codeant-ai-for-open-source
Copy link
Contributor

Sequence Diagram

This PR updates and extends documentation to explain how AI assistants connect to Superset through the MCP server so users can explore data, build charts and dashboards, and run SQL using natural language.

sequenceDiagram
    participant User
    participant AIClient as AI client
    participant MCPServer as MCP server
    participant Superset

    User->>AIClient: Ask question about data or charts
    AIClient->>MCPServer: Invoke Superset tool via MCP
    MCPServer->>Superset: Query metadata or execute SQL
    Superset-->>MCPServer: Return datasets charts or results
    MCPServer-->>AIClient: Respond with chart dashboard or link
    AIClient-->>User: Present answer and Superset links
Loading

Generated by CodeAnt AI

@netlify
Copy link

netlify bot commented Mar 11, 2026

Deploy Preview for superset-docs-preview ready!

Name Link
🔨 Latest commit 54019c4
🔍 Latest deploy log https://app.netlify.com/projects/superset-docs-preview/deploys/69b1a7de09d2990007347499
😎 Deploy Preview https://deploy-preview-38585--superset-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Member

@michael-s-molina michael-s-molina left a comment

Choose a reason for hiding this comment

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

LGTM but maybe @rusackas will have a better understanding about the overall organization.

@eschutho eschutho merged commit 65e21cf into apache:master Mar 12, 2026
75 of 76 checks passed
aminghadersohi added a commit to aminghadersohi/superset that referenced this pull request Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Namespace | Anything related to documentation size/L size:L This PR changes 100-499 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants