Zendesk Widgets MCP server

Zendesk Widgets are embeddable customer service components that can be deployed on websites and applications. An MCP server for Zendesk Widgets lets AI agents configure help widgets, customize themes, create contact forms, and manage customer-facing support interfaces.

Setting up an MCP server

This article covers the standard steps for creating an MCP server in AI Gateway and connecting it to an AI client. The steps are the same for every integration — application-specific details (API credentials, OAuth endpoints, and scopes) are covered in the individual application pages.

Before you begin

You'll need:

• Access to AI Gateway with permission to create MCP servers
• API credentials for the application you're connecting (see the relevant application page for what to collect)

Create an MCP server

Find the API in the catalog

1. Sign in to AI Gateway and select MCP Servers from the left navigation.
2. Select New MCP Server.
3. Search for the application you want to connect, then select it from the catalog.

Configure the server

1. Enter a Name for your server — something descriptive that identifies both the application and its purpose (for example, "Zendesk Support — Prod").
2. Enter a Description so your team knows what the server is for.
3. Set the Timeout value. 30 seconds works for most APIs; increase to 60 seconds for APIs that return large payloads.
4. Toggle Production mode on if this server will be used in a live workflow.
5. Select Next.

Configure authentication

Enter the authentication details for the application. This varies by service — see the Authentication section of the relevant application page for the specific credentials, OAuth URLs, and scopes to use.

Configure security

1. Set any Rate limits appropriate for your use case and the API's own limits.
2. Enable Logging if you want AI Gateway to record requests and responses for auditing.
3. Select Next.

Deploy

Review the summary, then select Deploy. AI Gateway provisions the server and provides a server URL you'll use when configuring your AI client.

---

Connect to an AI client

Once your server is deployed, you'll need to add it to the AI client your team uses. Select your client for setup instructions:

• Claude Desktop
• Claude Code
• Cursor
• VS Code
• Windsurf

Tips

• You can create multiple MCP servers for the same application — for example, a read-only server for reporting agents and a read-write server for automation workflows.
• If you're unsure which OAuth scopes to request, start with the minimum read-only set and add write scopes only when needed. Most application pages include scope recommendations.
• You can edit a server's name, description, timeout, and security settings after deployment without redeploying.

Authentication

Zendesk Widgets uses OAuth 2.0 authentication. Create an OAuth application in your Zendesk Admin Center (under Channels > Web Widget) and obtain a Client ID and Client Secret. The OAuth endpoints are subdomain-specific: https://{subdomain}.zendesk.com/oauth/authorizations/new for authorization and https://{subdomain}.zendesk.com/oauth/tokens for token exchange. Required scopes are read (view widget settings) and write (modify widget configuration). The base API URL is https://{subdomain}.zendesk.com/api/v2.

Available tools

The Zendesk Widgets MCP server provides tools for configuring web widgets, customizing themes, managing forms, and controlling widget behavior.

Widget Configuration

Tool	Description
get_widget_settings	Retrieve current widget configuration
update_widget_settings	Update widget display and behavior settings
get_widget_status	Check widget status and availability

Theme & Styling

Tool	Description
get_theme	Retrieve current theme configuration
update_theme	Update widget colors, fonts, and styling
upload_logo	Upload custom company logo
reset_theme	Reset theme to default

Forms & Fields

Tool	Description
list_form_fields	List available form fields
create_form_field	Add a custom field to the contact form
update_form_field	Modify form field properties
delete_form_field	Remove a form field
get_form_configuration	Retrieve form layout and requirements

Widget Features

Tool	Description
enable_chat	Enable or configure live chat
enable_help_center	Show help center search in widget
enable_contact_form	Enable contact form submission
enable_messaging	Configure messaging options
set_business_hours	Configure availability schedule

Analytics & Configuration

Tool	Description
get_analytics	Retrieve widget usage metrics
list_widget_analytics	List analytics over time period
get_widget_code	Retrieve embed code for website

Tips

Test the embed code in a development environment before deploying a widget to production to ensure it loads without JavaScript conflicts.

Use the set_business_hours tool to automatically show an offline form when support is unavailable.

Add clear labels and validation rules to custom form fields to reduce form abandonment.

Monitor analytics using get_analytics to identify which widget features are most used by customers.

Remember that changes apply immediately to all deployed instances when updating theme or form configuration.