What is Zendesk Mcp Server

zendesk-mcp-server is a comprehensive Model Context Protocol (MCP) server designed for interacting with the Zendesk API. It provides tools and resources for managing various Zendesk products including Support, Talk, Chat, and Guide.

Use cases

Use cases for zendesk-mcp-server include automating ticket management, integrating user and organization data, creating custom support workflows, and enhancing customer service operations through efficient API interactions.

How to use

To use zendesk-mcp-server, first ensure you have Node.js 14 or higher and a Zendesk account with API access. Clone the repository, install dependencies using ‘npm install’, create a ‘.env’ file with your Zendesk credentials, and then start the server with ‘npm start’. For development, use ‘npm run dev’.

Key features

Key features of zendesk-mcp-server include complete coverage of Zendesk API functionality, tools for managing tickets, users, organizations, and groups, resources for accessing Zendesk API documentation, and secure authentication using Zendesk API tokens.

Where to use

zendesk-mcp-server can be used in customer support environments, particularly in organizations that utilize Zendesk for managing customer interactions and support tickets.

Zendesk API MCP Server

A comprehensive Model Context Protocol (MCP) server for interacting with the Zendesk API. This server provides tools and resources for managing Zendesk Support, Talk, Chat, and Guide products.

## Features

- Complete coverage of Zendesk API functionality
- Tools for managing tickets, users, organizations, and more
- Resources for accessing Zendesk API documentation
- Secure authentication with Zendesk API tokens

## Getting Started

### Prerequisites

- Node.js 14 or higher
- A Zendesk account with API access

### Installation

1. Clone this repository
2. Install dependencies:
   ```
   npm install
   ```
3. Create a `.env` file with your Zendesk credentials:
   ```
   ZENDESK_SUBDOMAIN=your-subdomain
   [email protected]
   ZENDESK_API_TOKEN=your-api-token
   ```

### Running the Server

Start the server:
```
npm start
```

For development with auto-restart:
```
npm run dev
```

### Testing with MCP Inspector

Test the server using the MCP Inspector:
```
npm run inspect
```

## Available Tools

### Tickets
- `list_tickets`: List tickets in Zendesk
- `get_ticket`: Get a specific ticket by ID
- `create_ticket`: Create a new ticket
- `update_ticket`: Update an existing ticket
- `delete_ticket`: Delete a ticket

### Users
- `list_users`: List users in Zendesk
- `get_user`: Get a specific user by ID
- `create_user`: Create a new user
- `update_user`: Update an existing user
- `delete_user`: Delete a user

### Organizations
- `list_organizations`: List organizations in Zendesk
- `get_organization`: Get a specific organization by ID
- `create_organization`: Create a new organization
- `update_organization`: Update an existing organization
- `delete_organization`: Delete an organization

### Groups
- `list_groups`: List agent groups in Zendesk
- `get_group`: Get a specific group by ID
- `create_group`: Create a new agent group
- `update_group`: Update an existing group
- `delete_group`: Delete a group

### Macros
- `list_macros`: List macros in Zendesk
- `get_macro`: Get a specific macro by ID
- `create_macro`: Create a new macro
- `update_macro`: Update an existing macro
- `delete_macro`: Delete a macro

### Views
- `list_views`: List views in Zendesk
- `get_view`: Get a specific view by ID
- `create_view`: Create a new view
- `update_view`: Update an existing view
- `delete_view`: Delete a view

### Triggers
- `list_triggers`: List triggers in Zendesk
- `get_trigger`: Get a specific trigger by ID
- `create_trigger`: Create a new trigger
- `update_trigger`: Update an existing trigger
- `delete_trigger`: Delete a trigger

### Automations
- `list_automations`: List automations in Zendesk
- `get_automation`: Get a specific automation by ID
- `create_automation`: Create a new automation
- `update_automation`: Update an existing automation
- `delete_automation`: Delete an automation

### Search
- `search`: Search across Zendesk data

### Help Center
- `list_articles`: List Help Center articles
- `get_article`: Get a specific Help Center article by ID
- `create_article`: Create a new Help Center article
- `update_article`: Update an existing Help Center article
- `delete_article`: Delete a Help Center article

### Talk
- `get_talk_stats`: Get Zendesk Talk statistics

### Chat
- `list_chats`: List Zendesk Chat conversations

## Available Resources

- `zendesk://docs/{section}`: Access documentation for different sections of the Zendesk API

## License

MIT