Skip to content

update(docs): update mcp, custom tools, and variables docs#4192

Closed
TheodoreSpeaks wants to merge 2 commits intostagingfrom
doc/update-mcp
Closed

update(docs): update mcp, custom tools, and variables docs#4192
TheodoreSpeaks wants to merge 2 commits intostagingfrom
doc/update-mcp

Conversation

@TheodoreSpeaks
Copy link
Copy Markdown
Collaborator

Summary

Added more screenshots for mcp tools, custom tools, and variables docs.

Updated out of date documentation, added cleaner info panels (table comparisons, tabbed content)

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation
  • Other: ___________

Testing

I read it.

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Screenshots/Videos

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 16, 2026 1:43am

Request Review

@cursor
Copy link
Copy Markdown

cursor bot commented Apr 16, 2026

PR Summary

Low Risk
Documentation-only changes (MDX/nav) with no runtime code or behavioral impact beyond potential broken image paths/wording inaccuracies.

Overview
Adds a new Custom Tools documentation page describing schema/code/scoping, agent usage, and permissions, and links it into the docs nav.

Updates MCP docs to reflect the current UI and setup flow (server creation, workflow-to-tool deployment, client configuration), with new screenshots and clearer guidance on refresh/auth and when to use Agent vs MCP Tool.

Updates the workflow variables guide with new screenshots and revised instructions for opening the Variables panel, plus a small terminology tweak (TextPlain).

Reviewed by Cursor Bugbot for commit c0de014. Bugbot is set up for automated code reviews on this repo. Configure here.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 16, 2026

Greptile Summary

Adds a new Custom Tools documentation page and updates the MCP and Variables docs with current UI screenshots, rewritten step-by-step flows, and comparison tables replacing unstructured bullet lists. The variables-menu.png / variables-panel.png images are new additions, and the old mcp-2.png / mcp-3.png image references are replaced with descriptively-named files.

Confidence Score: 5/5

Safe to merge — documentation-only changes with no runtime impact.

All findings are P2 style suggestions. No code logic is changed; every image file referenced in the MDX is present in the PR, and the Image component path already existed in the codebase.

No files require special attention.

Important Files Changed

Filename Overview
apps/docs/content/docs/en/custom-tools/index.mdx New page documenting Custom Tools — schema format, creation steps, comparison table vs MCP tools, and permission requirements. Well-structured and accurate.
apps/docs/content/docs/en/mcp/index.mdx Updated with more granular steps, new screenshots, and a comparison table replacing bullet lists. Minor grammar issue: "a MCP" should be "an MCP" in the section heading.
apps/docs/content/docs/en/mcp/deploy-workflows.mdx Refreshed deploy-as-MCP guide with step-by-step screenshots, updated client config section listing Cursor, Claude Code, Claude Desktop, VS Code, and Sim as supported clients.
apps/docs/content/docs/en/variables/workflow-variables.mdx Added images for the variables menu and panel, added panel-open instructions, renamed "Text" tab to "Plain" to match UI, and documented the Type field.
apps/docs/content/docs/en/meta.json Added "custom-tools" entry to the Features navigation section, correctly positioned after "mcp".

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    subgraph Inbound["Using External MCP Tools (mcp/index.mdx)"]
        A[External MCP Server] -->|Settings → MCP Tools → Add| B[Workspace MCP Tool Registry]
        B -->|Add tool... → MCP Servers| C[Agent Block]
        B -->|Explicit params| D[MCP Tool Block]
    end

    subgraph Outbound["Deploying Workflows as MCP (mcp/deploy-workflows.mdx)"]
        E[Deployed Workflow] -->|Deploy → MCP tab → Save Tool| F[MCP Server in Sim]
        F -->|Server URL + X-API-Key| G[External MCP Clients]
        G --> G1[Cursor]
        G --> G2[Claude Code]
        G --> G3[Claude Desktop]
        G --> G4[VS Code]
    end

    subgraph Inline["Custom Tools (custom-tools/index.mdx)"]
        H[Schema + JS Code] -->|Settings → Custom Tools → Add| I[Workspace Custom Tool Registry]
        I -->|Add tool... → Custom Tools| C
    end
Loading

Reviews (1): Last reviewed commit: "update(docs): update mcp, custom tools, ..." | Re-trigger Greptile

Comment thread apps/docs/content/docs/en/mcp/index.mdx Outdated
@TheodoreSpeaks
Copy link
Copy Markdown
Collaborator Author

merged into big docs pr. #4110

@TheodoreSpeaks TheodoreSpeaks deleted the doc/update-mcp branch April 16, 2026 02:03
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.

1 participant