Skip to main content

Zendesk Platform MCP server

Zendesk Platform provides APIs for extending Zendesk with custom objects, data models, apps, and business logic. An MCP server for Zendesk Platform lets AI agents create custom data structures, manage apps, configure webhooks, and build complex automations on top of Zendesk.

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 Authentication section on this page.

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 Authentication section on this page for what to collect).

Create an MCP server

Find the app in the catalog

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

App Configuration

Confirm the Base URL for the API, then, under Tools, select the endpoints you want to expose. Select Next.

MCP Server Setup

  1. Enter a Name for your server — something descriptive that identifies both the application and its purpose.
  2. Enter a Description so your team knows what the server is for.
  3. Set the log level: choose Production Mode for terser logs, or Non-Production Mode for more verbose logs that can help with debugging.
  4. Select Next.

Authentication

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

Review

Look over the summary of your MCP server configuration, then select Create & 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:

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.

Authentication

Zendesk Platform uses OAuth 2.0 authentication. Create an OAuth application in your Zendesk Admin Center and obtain a Client ID and Client Secret. In Zendesk, go to Admin Center > Apps and integrations > OAuth Clients and click Add OAuth Client to register your application.

ValueSetting
Auth endpointhttps://{subdomain}.zendesk.com/oauth/authorizations/new
Token endpointhttps://{subdomain}.zendesk.com/oauth/tokens
Base URLhttps://{subdomain}.zendesk.com/api/sunshine
Scopesread, write, apps:read, apps:write, custom_objects:read, custom_objects:write

Available tools

The Zendesk Platform MCP server provides tools for managing custom objects, apps, webhooks, and advanced platform configurations.

Custom Objects

ToolDescription
create_custom_objectCreate a new custom object type
get_custom_objectRetrieve custom object schema
update_custom_objectUpdate custom object definition
delete_custom_objectDelete a custom object
list_custom_objectsList all custom objects
create_custom_object_recordCreate a record of a custom object
update_custom_object_recordUpdate a custom object record
delete_custom_object_recordDelete a custom object record
list_custom_object_recordsList records with filtering

Apps Framework

ToolDescription
create_appCreate a new Zendesk app
get_appRetrieve app details
update_appUpdate app configuration
delete_appDelete an app
list_appsList installed apps
create_installationInstall an app on the instance
list_installationsList app installations
update_installationConfigure app installation

Webhooks & Targets

ToolDescription
create_webhookCreate a webhook trigger
get_webhookRetrieve webhook configuration
update_webhookUpdate webhook settings
delete_webhookDelete a webhook
list_webhooksList configured webhooks
create_targetCreate a webhook target endpoint
list_targetsList webhook targets

Custom Fields & Admin Settings

ToolDescription
create_custom_fieldCreate a custom field
get_custom_fieldRetrieve field configuration
list_custom_fieldsList custom fields
update_custom_fieldUpdate field settings
list_rolesList available roles
list_groupsList user groups

Tips

Plan relationships and field types carefully before creating custom objects in production — custom objects require careful schema design upfront.

Use custom_objects:read scope for read-only access to minimize security risk.

Test apps thoroughly in a development environment first — app installation is immediate and affects all users.

Include retry logic on the receiving endpoint to handle network failures in webhook configurations.

Always validate webhook signatures before processing events to ensure they originate from Zendesk.