Zendesk MCP Server API Reference¶

Comprehensive Zendesk integration MCP server providing ticket management, user operations, and knowledge base access using FastMCP

This reference provides detailed information about all available tools and their parameters.

Available Tools¶

`create_ticket`¶

Description: Create a new support ticket in Zendesk

Parameters:

subject (string) (required): Subject/title of the ticket
description (string) (required): Initial description or comment for the ticket
requester_email (string) (optional): Email address of the person requesting support
priority (string) (optional): Priority level of the ticket
type (string) (optional): Type of the ticket
tags (array) (optional): Tags to associate with the ticket

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk create_ticket

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "create_ticket", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "create_ticket", "arguments": {}}'

`get_ticket`¶

Description: Retrieve detailed information about a specific ticket

Parameters:

ticket_id (integer) (required): ID of the ticket to retrieve
include_comments (boolean) (optional): Include ticket comments in the response

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk get_ticket

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "get_ticket", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "get_ticket", "arguments": {}}'

`update_ticket`¶

Description: Update an existing ticket's properties

Parameters:

ticket_id (integer) (required): ID of the ticket to update
status (string) (optional): New status for the ticket
priority (string) (optional): New priority for the ticket
assignee_id (integer) (optional): ID of the agent to assign the ticket to
tags (array) (optional): Tags to add or update on the ticket

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk update_ticket

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "update_ticket", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "update_ticket", "arguments": {}}'

`search_tickets`¶

Description: Search for tickets using various criteria

Parameters:

query (string) (optional): Search query using Zendesk search syntax
status (string) (optional): Filter by ticket status
priority (string) (optional): Filter by ticket priority
requester_email (string) (optional): Filter by requester email address
created_after (string) (optional): Filter tickets created after this date (ISO format)
limit (integer) (optional): Maximum number of tickets to return

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk search_tickets

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "search_tickets", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "search_tickets", "arguments": {}}'

`add_ticket_comment`¶

Description: Add a comment to an existing ticket

Parameters:

ticket_id (integer) (required): ID of the ticket to comment on
body (string) (required): Content of the comment
public (boolean) (optional): Whether the comment is public (visible to requester) or internal
author_id (integer) (optional): ID of the comment author (defaults to authenticated user)

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk add_ticket_comment

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "add_ticket_comment", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "add_ticket_comment", "arguments": {}}'

`create_user`¶

Description: Create a new user in Zendesk

Parameters:

name (string) (required): Full name of the user
email (string) (required): Email address of the user
role (string) (optional): Role for the user
organization_id (integer) (optional): ID of the organization to associate the user with

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk create_user

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "create_user", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "create_user", "arguments": {}}'

`get_user`¶

Description: Retrieve information about a specific user

Parameters:

user_id (integer) (optional): ID of the user to retrieve
email (string) (optional): Email address of the user to retrieve

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk get_user

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "get_user", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "get_user", "arguments": {}}'

`search_users`¶

Description: Search for users in Zendesk

Parameters:

query (string) (optional): Search query for users
role (string) (optional): Filter by user role
organization_id (integer) (optional): Filter by organization ID

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk search_users

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "search_users", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "search_users", "arguments": {}}'

`search_articles`¶

Description: Search knowledge base articles

Parameters:

query (string) (required): Search query for articles
locale (string) (optional): Language locale for articles
section_id (integer) (optional): Filter by specific section ID

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk search_articles

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "search_articles", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "search_articles", "arguments": {}}'

`get_article`¶

Description: Retrieve a specific knowledge base article

Parameters:

article_id (integer) (required): ID of the article to retrieve
locale (string) (optional): Language locale for the article

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk get_article

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "get_article", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "get_article", "arguments": {}}'

`get_ticket_metrics`¶

Description: Get metrics and analytics for tickets

Parameters:

start_date (string) (optional): Start date for metrics (ISO format)
end_date (string) (optional): End date for metrics (ISO format)
group_by (string) (optional): Group metrics by specific field

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk get_ticket_metrics

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "get_ticket_metrics", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "get_ticket_metrics", "arguments": {}}'

`list_organizations`¶

Description: List organizations in Zendesk

Parameters:

query (string) (optional): Search query for organizations

Example Usage:

CLIPythonHTTP API

mcp_platform call zendesk list_organizations

from mcp_platform.client import MCPClient

client = MCPClient()
result = client.call_tool("zendesk", "list_organizations", {})

curl -X POST http://localhost:8000/v1/call \
  -H "Content-Type: application/json" \
  -d '{"template_id": "zendesk", "tool_name": "list_organizations", "arguments": {}}'

Integration Examples¶

For more integration examples and usage patterns, see the Usage Guide.

Support¶

For questions and issues related to the Zendesk MCP Server, please refer to: - Usage Guide for comprehensive examples - Template Overview for setup and configuration - MCP Platform Documentation for general platform usage

Zendesk MCP Server API Reference¶

Available Tools¶

create_ticket¶

get_ticket¶

update_ticket¶

search_tickets¶

add_ticket_comment¶

create_user¶

get_user¶

search_users¶

search_articles¶

get_article¶

get_ticket_metrics¶

list_organizations¶

Integration Examples¶

Support¶

`create_ticket`¶

`get_ticket`¶

`update_ticket`¶

`search_tickets`¶

`add_ticket_comment`¶

`create_user`¶

`get_user`¶

`search_users`¶

`search_articles`¶

`get_article`¶

`get_ticket_metrics`¶

`list_organizations`¶