WHAT YOU'LL LEARN
  • how to use AI assistant with Webiny documentation
  • how to connect to the Remote Webiny MCP Server for enhanced AI assistance

In this guide, you’ll learn how you can use AI assistants and Remote MCP Server effectively in your Webiny development workflow.

Webiny MCP Server
anchor

The Webiny documentation provides a remote Model Context Protocol (MCP) server that allows you to find information from the Webiny documentation right in your IDEs or AI tools, such as Cursor. You can ensure your AI tools have current Webiny knowledge through the Webiny MCP server. This provides real-time access to the latest documentation, helping AI tools avoid outdated recommendations and ensuring they understand current best practices.

What is MCP?

Model Context Protocolexternal link (MCP) is a standardized way for AI tools to access external tools and data sources.

Server Details
anchor

  • Name: Webiny Docs
  • URL: https://mcp.docs.webiny.com/mcp
  • Transport: Streamable HTTP

You can add it to AI agents that support connecting to MCP servers.

Cursor
anchor

To connect to the Webiny MCP server in Cursor, add the following to your .cursor/mcp.json file or Cursor settings, as explained in the Cursor documentationexternal link:

VS Code
anchor

Click hereexternal link to add the Webiny MCP server to VS Code.

To manually connect to the Webiny MCP server in VS Code, add the following to your .vscode/mcp.json file in your workspace:

Learn more in the VS Code documentationexternal link.

Additional One-Time Setup in VS Code
Sometimes, in VS Code, you may need to perform a one-time setup. When you ask a question and include a phrase like “use Webiny Docs”, then VS Code will prompt you to enable the Webiny MCP server for all sessions. Allow it, and the setup will be complete. This step is required only once. Please refer to the image below for reference.
VS Code Webiny MCP ServerVS Code Webiny MCP Server
(click to enlarge)

Claude Desktop
anchor

To connect to the Webiny MCP server in Claude Desktop, add the following to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%\Claude\claude_desktop_config.json

Learn more in the Claude Desktop documentationexternal link.

Manual Setup
anchor

Many tools support a common JSON configuration format for MCP servers. If there are not specific instructions for your chosen tool, you may be able to add the Webiny Docs MCP server by including the following configuration in your tool’s MCP settings:

Streamable HTTP:

Local Proxy:

Claude Code CLI
anchor

Claude Codeexternal link is an agentic coding tool that runs on the command line. Enabling the Webiny Docs MCP server allows it to access the latest documentation while generating Webiny code.

Install using the terminal command:

Learn more about using MCP servers with Claude Codeexternal link.

Claude Code GitHub Action
anchor

Claude Code also provides a GitHub Action that can be used to run commands in response to GitHub events. Enabling the Webiny Docs MCP server allows it to access the latest documentation while answering questions in comments or generating Webiny code.

You can configure it to use the Webiny Docs MCP server for documentation access by adding the following to the workflow file:

Learn more about using MCP servers with the Claude Code GitHub Actionexternal link.

Warp
anchor

Warpexternal link is an agent development environment built for coding with multiple AI agents. Adding the Webiny Docs MCP server allows Warp to access the latest Webiny documentation when answering questions or performing coding tasks.

  1. Open your Warp settings and go to AI > MCP Servers > Manage MCP Servers.
  2. Click “Add”.
  3. Enter the following configuration. You can optionally configure the Webiny MCP server to activate on startup using the start_on_launch flag:
  4. Click “Save”.

Learn more about using MCP servers with Warpexternal link.

Claude.ai
anchor

Claude.aiexternal link is a general-purpose AI assistant. Adding the Webiny Docs MCP server allows it to access the latest documentation when answering Webiny questions or generating Webiny code.

  1. Navigate to the Claude.ai connector settingsexternal link.
  2. Click “Add custom connector”. You may need to scroll down to find this option.
  3. Enter the server URL: https://mcp.docs.webiny.com/mcp.
  4. Set the name to “Webiny docs”.

Learn more about using MCP servers with Claude.aiexternal link.

Windsurf
anchor

Windsurfexternal link is an AI-powered agentic coding tool, available as editor plugins or a standalone editor. It can use the Webiny Docs MCP server to access documentation while performing coding tasks.

Windsurf doesn’t support streaming HTTP, so it requires a local proxy configuration:

  1. Open ~/.codeium/windsurf/mcp_config.json in your editor.
  2. Add the following configuration to your Windsurf MCP settings:
  3. Save the configuration and restart Windsurf.

Learn more about using MCP servers with Windsurfexternal link.

Gemini CLI
anchor

Gemini CLI is a command-line AI coding tool that can use the Webiny Docs MCP server to access documentation while generating Webiny code.

You can configure MCP servers at the global level in the ~/.gemini/settings.json file, or in a .gemini/settings.json file in a project root.

Learn more about using MCP servers with Gemini CLIexternal link.

Zed
anchor

Zedexternal link supports MCP servers when using its AI capabilities. It can use the Webiny Docs MCP server to access documentation while performing coding tasks.

Zed doesn’t support streaming HTTP, so it requires a local proxy configuration:

  1. Open ~/.config/zed/settings.json in your editor.
  2. Add the following configuration to your Zed MCP settings:
  3. Save the configuration.

Learn more about using MCP servers with Zedexternal link.

ChatGPT
anchor

Limited availability

MCP server integration is only available for ChatGPT Pro, Team, and Enterprise users. The setup process is more complex than other tools.

Refer to the OpenAI MCP documentationexternal link for specific setup instructions.

Usage
anchor

Once configured, you can ask your AI tool questions about Webiny, and it will retrieve information directly from the latest docs. Coding agents will be able to consult the latest documentation when performing coding tasks, and chatbots will be able to accurately answer questions about Webiny features, APIs, and best practices.

Troubleshooting
anchor

If you encounter issues:

  • Verify that your tool supports streamable HTTP transport.
  • Check that the server URL is correct: https://mcp.docs.webiny.com/mcp.
  • Ensure your tool has proper internet access.
  • Consult your specific tool’s MCP integration documentation.

If you are still having problems, please reach out to our community support channelsexternal link for assistance.

AI Assistant in Documentation
anchor

The Webiny documentation is equipped with an AI Assistant that can answer your questions and help you build customizations with Webiny. To open the AI Assistant, Click the “Ask AI” button in the bottom right corner of the documentation.

You can then ask the AI Assistant any questions about Webiny and the AI Assistant will provide you with relevant documentation links, code snippets, and explanations to help you with your development.

FAQ
anchor

Can I Use the MCP Server With Any AI Assistant?
anchor

The MCP server works with any AI assistant or tool that supports the Model Context Protocol. This includes popular tools like Cursor, VSCode with Copilot, Claude Desktop, and many others.

Is the Webiny MCP Server Free to Use?
anchor

Yes, the Webiny MCP server is free to use and provides access to all public Webiny documentation.

How Often Is the MCP Server Updated?
anchor

The MCP server is automatically updated whenever the Webiny documentation is updated, ensuring you always have access to the latest information.