eDesk MCP by usefulapi
Work with eDesk support tickets, replies, internal notes, contacts and sales orders.
我該用這個嗎
品質與安全性
根據工具定義與協定合規性的自動化分析。
上下文成本
這是每次將伺服器的工具載入模型上下文時所消耗的約略 token 數量。數量越高，可用於其他工作的注意力就越少。
安裝
一鍵安裝
將以下內容加入你的 `claude_desktop_config.json` 檔案：
{
"mcpServers": {
"edesk": {
"url": "https://edesk.usefulapi.io/mcp"
}
}
}遠端端點
https://edesk.usefulapi.io/mcpstreamable-http它能做什麼
工具清單
工具（18）
🟢edesk_whoami
The eDesk user the API token belongs to: id, name, email, username, role and active flag. GET /whoami.
輸入結構描述
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_list_users(page, items_per_page)
List the eDesk users (support agents) with id, name, email, username, role and active flag. Use the ids as ticket owners. GET /users.
輸入結構描述
{
"type": "object",
"properties": {
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"items_per_page": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_list_channels(page, items_per_page)
List the sales channels connected to eDesk (Amazon, eBay, Shopify, email, ...) with id, type, name, country and currency. Use the ids to filter tickets and orders. GET /channels.
輸入結構描述
{
"type": "object",
"properties": {
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"items_per_page": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_list_tag_groups(page, items_per_page)
List the tag groups that organize ticket tags. GET /tag-groups.
輸入結構描述
{
"type": "object",
"properties": {
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"items_per_page": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_list_tags(page, items_per_page)
List ticket tags with id, name, color, active flag and tag group id. Use the ids in edesk_update_ticket (tag_ids). GET /tags.
輸入結構描述
{
"type": "object",
"properties": {
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"items_per_page": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_list_templates(page, items_per_page)
List saved reply templates (id, name, subject, body text, channels, usage). GET /templates.
輸入結構描述
{
"type": "object",
"properties": {
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"items_per_page": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_get_template(template_id)
One reply template by id. GET /templates/{id}.
輸入結構描述
{
"type": "object",
"properties": {
"template_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "eDesk template id."
}
},
"required": [
"template_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_list_tickets(status, type, channel_id, contact_id, owner_user_id, ...)
List support tickets from all channels with subject, type, status, channel, owner, contact, linked sales order id, tag ids, message ids, reply count and AI classification. Filter by status, type, channel, contact, owner, sales order, seller (marketplace) order id and last-updated date. GET /tickets.
輸入結構描述
{
"type": "object",
"properties": {
"status": {
"description": "Only tickets with this status.",
"type": "string",
"enum": [
"Scheduled",
"Spam",
"Unread",
"Read",
"Unpriority",
"Priority",
"Archived",
"Open",
"Pending",
"Closed"
]
},
"type": {
"description": "Only tickets of this type.",
"type": "string",
"enum": [
"BuyerNotes",
"Cancellation",
"Chat",
"Chatbot",
"ContactBuyer",
"ContactForm",
"DefectiveItemReceived",
"FeedbackReply",
"Incident",
"InvoiceRequest",
"NegativeFeedback",
"OfferQuery",
"OrderAdjustment",
"OrderClaim",
"OrderQuery",
"OrderShippingInquiry",
"PaymentsQuery",
"Presales",
"ProductQuery",
"PublicMessage",
"Query",
"Refund",
"ResolutionCase",
"ReturnRequest",
"ReturnsQuery",
"SampleQuery",
"ShippingQuery",
"SystemMessage",
"WrongItemReceived"
]
},
"channel_id": {
"description": "Only tickets on this channel (see edesk_list_channels).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"contact_id": {
"description": "Only tickets of this contact (customer).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"owner_user_id": {
"description": "Only tickets assigned to this user.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"sales_order_id": {
"description": "Only tickets linked to this eDesk sales order id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"seller_order_id": {
"description": "Only tickets for this marketplace order id (the id the marketplace shows).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"updated_after": {
"description": "Only tickets last updated on or after this date, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"updated_before": {
"description": "Only tickets last updated on or before this date, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"order_by": {
"description": "Sort field.",
"type": "string",
"enum": [
"id",
"created_at",
"last_updated_at"
]
},
"order_direction": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"items_per_page": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_get_ticket(ticket_id)
One ticket by id with its status, owner, tags, custom fields, linked sales order and the ids of its messages (read each with edesk_get_message). GET /tickets/{id}.
輸入結構描述
{
"type": "object",
"properties": {
"ticket_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "eDesk ticket id."
}
},
"required": [
"ticket_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_get_message(message_id)
One ticket message or internal note by id (from a ticket's message ids): body, direction, type (Message or Note), author and attachments. GET /messages/{id}.
輸入結構描述
{
"type": "object",
"properties": {
"message_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "eDesk message id."
}
},
"required": [
"message_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_list_contacts(query, email, name, phone_number, consumer_id, ...)
Search the contacts (customers) of the helpdesk by free text, email, name, phone number or consumer id. Returns id, channel, full name, email and phone. GET /contacts.
輸入結構描述
{
"type": "object",
"properties": {
"query": {
"description": "Free-text search.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"email": {
"description": "Filter by email.",
"type": "string",
"minLength": 1,
"maxLength": 320
},
"name": {
"description": "Filter by full name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"phone_number": {
"description": "Filter by phone number.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"consumer_id": {
"description": "Filter by consumer id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"items_per_page": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_list_sales_orders(status, channel_id, contact_id, seller_order_id, id_from, ...)
List the marketplace/store orders that eDesk holds, with status, items, amounts, addresses, tracking codes and the linked ticket id. Filter by status, channel, contact, marketplace order id, id range and created/updated dates. GET /sales-orders.
輸入結構描述
{
"type": "object",
"properties": {
"status": {
"description": "Only orders with this status.",
"type": "string",
"enum": [
"OrderReceived",
"PaymentReceived",
"PaymentRejected",
"PaymentAccepted",
"OrderShipped",
"InTransit",
"Delivered",
"Canceled",
"Returned",
"Hold"
]
},
"channel_id": {
"description": "Only orders from this channel.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"contact_id": {
"description": "Only orders of this contact.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"seller_order_id": {
"description": "Only the order with this marketplace order id.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"id_from": {
"description": "Only orders with an eDesk id greater than or equal to this.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"id_to": {
"description": "Only orders with an eDesk id less than or equal to this.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_after": {
"description": "Only orders created on or after this date, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"created_before": {
"description": "Only orders created on or before this date, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"updated_after": {
"description": "Only orders last updated on or after this date, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"updated_before": {
"description": "Only orders last updated on or before this date, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"order_by": {
"description": "Sort field.",
"type": "string",
"enum": [
"id",
"created_at",
"last_updated_at"
]
},
"order_direction": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"items_per_page": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_get_sales_order(sales_order_id)
One sales order by id with items, amounts, ship-to and bill-to addresses, tracking codes, delivery dates, the linked ticket id and order note ids. GET /sales-orders/{id}.
輸入結構描述
{
"type": "object",
"properties": {
"sales_order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "eDesk sales order id (the sales_order_id on a ticket)."
}
},
"required": [
"sales_order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢edesk_list_order_notes(page, items_per_page)
List the internal notes attached to sales orders (id, sales order id, author, text, attachments). GET /order-notes.
輸入結構描述
{
"type": "object",
"properties": {
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"items_per_page": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴edesk_update_ticket(ticket_id, status, owner_user_id, tag_ids, subject)
WRITE: change a ticket's status, owner (assignee), tags or subject. Only the fields you pass are sent. tag_ids is sent as given: read the ticket first (tags_ids) and include the tags to keep. Nothing is sent to the customer. PUT /tickets/{id}.
輸入結構描述
{
"type": "object",
"properties": {
"ticket_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "eDesk ticket id."
},
"status": {
"description": "New status, e.g. Open, Pending or Closed.",
"type": "string",
"enum": [
"Scheduled",
"Spam",
"Unread",
"Read",
"Unpriority",
"Priority",
"Archived",
"Open",
"Pending",
"Closed"
]
},
"owner_user_id": {
"description": "User id to assign the ticket to (see edesk_list_users).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"tag_ids": {
"description": "Tag ids for the ticket (see edesk_list_tags).",
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"subject": {
"description": "New subject.",
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"ticket_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴edesk_add_ticket_note(ticket_id, text)
WRITE: add an internal note to a ticket. The note is for the team only and is never sent to the customer. POST /messages with type Note.
輸入結構描述
{
"type": "object",
"properties": {
"ticket_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "eDesk ticket id."
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 20000,
"description": "The note text."
}
},
"required": [
"ticket_id",
"text"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴edesk_reply_to_ticket(ticket_id, text, subject)
WRITE, CUSTOMER-VISIBLE: send a reply on a ticket. eDesk queues it for delivery to the marketplace or email channel, so it cannot be recalled once queued. The audience is the channel's default: on a Mirakl channel it is the channel's "Default messages recipients" setting (customer, operator or both), and this API cannot choose recipients (use the eDesk reply box when they matter). Only call this when the user has approved the exact text and audience. If the call fails in transit, the reply may still be queued: check the ticket before retrying. Use edesk_add_ticket_note for an internal note. POST /messages with type Message.
輸入結構描述
{
"type": "object",
"properties": {
"ticket_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "eDesk ticket id."
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 20000,
"description": "The reply text the customer will receive."
},
"subject": {
"description": "Subject, for channels that use one (such as email).",
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"ticket_id",
"text"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴edesk_add_order_note(sales_order_id, text)
WRITE: add an internal note to a sales order (never sent to the customer). POST /order-notes.
輸入結構描述
{
"type": "object",
"properties": {
"sales_order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "eDesk sales order id."
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 20000,
"description": "The note text."
}
},
"required": [
"sales_order_id",
"text"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}社群
證據