MCP Server
Connect your favorite AI tools — Claude Desktop, VS Code, Cursor, Windsurf, Claude Code, and more — to Yaplet using the Model Context Protocol. Manage your entire account through natural conversation.
What Is MCP?
The Model Context Protocol (MCP) is an open standard that lets AI assistants connect to external services and use their tools. Yaplet exposes an MCP server so you can manage your account from any MCP-compatible client — create chatbots, write knowledge base articles, send campaign emails, manage conversations, and more, all through natural language.
How Authentication Works
Yaplet's MCP server supports two authentication methods:
OAuth 2.0 (Browser Login)
The default method. Just add the server URL to your client — when you connect, your browser opens a login page where you sign in with your Yaplet account, pick your organization, and approve access. Each action is traced to your personal user account, and you can choose which tool categories to grant access to.
API Key
For clients that don't support OAuth redirects (like Cursor or Antigravity), you can authenticate with your organization's API key instead. Generate one at Settings > API Settings in your dashboard, then pass it as a Bearer token in the Authorization header of your MCP config.
Setup Guides
Yaplet's MCP server is available at:
https://yaplet.com/api/mcp
It uses the Streamable HTTP transport — the current MCP standard. Select your client below for setup instructions.
Claude Desktop supports remote MCP servers through its Connectors feature with automatic browser login.
Open Settings
In Claude Desktop, go to Settings > Connectors.
Add a New Connector
Click Add Connector and configure it:
- Name: Yaplet
- URL:
https://yaplet.com/api/mcp
Log In
Your browser will open automatically. Sign in with your Yaplet account, select your organization, and approve access. That's it — no API key needed.
Start Using It
Open a new conversation and you'll see Yaplet's tools available. Ask something like "List my widgets" to verify the connection.
mcp-remote bridge as a fallback. Add this to your claude_desktop_config.json:{
"mcpServers": {
"yaplet": {
"command": "npx",
"args": [
"-y", "mcp-remote",
"https://yaplet.com/api/mcp"
]
}
}
}
mcp-remote will open a browser window for you to log in.
{
"mcpServers": {
"yaplet": {
"command": "npx",
"args": [
"-y", "mcp-remote",
"https://yaplet.com/api/mcp",
"--header", "Authorization:Bearer yAPI_your-api-key-here"
]
}
}
}
Config file location:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
Claude Code supports remote MCP servers natively. Just add the URL and it handles authentication through your browser.
Option A: CLI Command
Run this in your terminal:
claude mcp add --transport http yaplet https://yaplet.com/api/mcp
When you first use the tools, your browser will open for you to log in and authorize access.
Option B: Project Config File
Create or edit .mcp.json in your project root:
{
"mcpServers": {
"yaplet": {
"type": "http",
"url": "https://yaplet.com/api/mcp"
}
}
}
Option C: API Key
If browser login doesn't work, use your API key instead. Create or edit .mcp.json in your project root:
{
"mcpServers": {
"yaplet": {
"type": "http",
"url": "https://yaplet.com/api/mcp",
"headers": {
"Authorization": "Bearer yAPI_your-api-key-here"
}
}
}
}
Verify
Type /mcp in the Claude Code chat panel to see connected servers and confirm Yaplet is listed.
VS Code supports MCP servers for GitHub Copilot's Agent mode.
Open MCP Settings
Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and run MCP: Open User Configuration.
Alternatively, create or edit .vscode/mcp.json in your workspace for project-scoped config.
Add Yaplet
Add this to your mcp.json:
{
"servers": {
"yaplet": {
"type": "http",
"url": "https://yaplet.com/api/mcp"
}
}
}
When you first use the tools, your browser will open for you to log in and approve access.
headers field:{
"servers": {
"yaplet": {
"type": "http",
"url": "https://yaplet.com/api/mcp",
"headers": {
"Authorization": "Bearer yAPI_your-api-key-here"
}
}
}
}
Switch to Agent Mode
In Copilot Chat, switch to Agent mode (click the mode dropdown at the top of the chat panel). MCP tools are only available in Agent mode.
Start Using It
Ask Copilot something like "List my Yaplet chatbots" and it will use the MCP tools.
Cursor has built-in MCP support with both global and project-level configuration.
Open MCP Settings
Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and select View: Open MCP Settings. Or go to Settings > Features > MCP Servers.
Add Yaplet
Create or edit .cursor/mcp.json in your project root (or ~/.cursor/mcp.json for global access):
{
"mcpServers": {
"yaplet": {
"url": "https://yaplet.com/api/mcp"
}
}
}
When you first use the tools, your browser will open for you to log in and approve access.
{
"mcpServers": {
"yaplet": {
"url": "https://yaplet.com/api/mcp",
"headers": {
"Authorization": "Bearer yAPI_your-api-key-here"
}
}
}
}
Restart Cursor
Restart the editor completely to pick up the new server.
Verify
Check Settings > Features > MCP Servers to confirm Yaplet appears as connected.
Windsurf supports MCP servers through its Cascade AI panel.
Open MCP Config
Click the MCPs icon in the top-right corner of the Cascade panel and select Configure. This opens the config file directly.
Alternatively, edit the file manually:
- macOS / Linux:
~/.codeium/windsurf/mcp_config.json - Windows:
%USERPROFILE%\.codeium\windsurf\mcp_config.json
Add Yaplet
{
"mcpServers": {
"yaplet": {
"serverUrl": "https://yaplet.com/api/mcp"
}
}
}
When you first connect, your browser will open for you to log in and approve access.
headers field:{
"mcpServers": {
"yaplet": {
"serverUrl": "https://yaplet.com/api/mcp",
"headers": {
"Authorization": "Bearer yAPI_your-api-key-here"
}
}
}
}
Restart Windsurf
Restart the editor to connect to the new server.
Verify
Open the Cascade panel and check the MCPs icon to confirm Yaplet is connected.
https://yaplet.com/api/mcp — the client will handle OAuth login automatically. If your client doesn't support OAuth redirects, pass your API key as a Bearer token in the Authorization header.Available Tools
The MCP server exposes 20 tools organized into eight categories. Each category maps to a permission that can be enabled or disabled independently.
Data Access
Browse and inspect any resource in your organization — widgets, chatbots, conversations, contacts, and more.
Widget Tools
Create and configure chat widgets, generate install code, and connect resources like chatbots and knowledge bases.
Help Tools
Manage knowledge bases (HTML articles) and documentation portals (Markdown pages). Create content with AI, organize with categories, and control publishing.
Conversation Tools
Read chat messages, search conversations, assign chats to agents, and send replies or private notes.
Newsletter Tools
Create email campaigns with AI content, build automation workflows, and check email performance.
How Tools Work Together
Most tasks involve multiple tools working in sequence. You don't need to orchestrate this manually — just describe what you want and the AI handles the rest.
Discover
The AI starts by listing existing resources (list_records) to find IDs and understand what's already set up.
Inspect
If needed, it fetches full details of a specific resource (get_record) to check current configuration.
Act
It uses the right management tool to create, update, or configure resources. All management tools follow the same pattern: omit the id to create, provide an id to update.
Connect
Finally, it links resources together — connecting a chatbot to a widget, assigning an article to a category, or publishing content.
Example: Asking "Create a chatbot called Support Bot and connect it to my main widget" would automatically list your widgets, create the chatbot, and link it — all from a single prompt.
Privacy & Security
- All requests are authenticated and scoped to your organization.
- OAuth tokens are scoped to the permissions you approve during login. Actions are traced to your personal user account.
- API key connections act as the organization owner with access to all enabled Copilot tool categories — no per-category scope restriction.
- External callers (OAuth) cannot see private agent notes in conversations. API key callers have full access, including private notes.
- All actions are logged and traceable to the authenticated user.