keyCRM MCP by usefulapi
Read orders, buyers, products and pipeline cards; add or remove order tags in keyCRM.
¿Debería usar esto?
Calidad y seguridad
Basado en el análisis automatizado de las definiciones de herramientas y el cumplimiento del protocolo.
Costo de contexto
Este es el número aproximado de tokens que se consumen cada vez que las herramientas del servidor se cargan en el contexto de un modelo. Los recuentos más altos reducen la atención disponible para otras tareas.
Instalar
Instalación con un clic
Agrega esto a tu archivo `claude_desktop_config.json`:
{
"mcpServers": {
"keycrm": {
"url": "https://keycrm.usefulapi.io/mcp"
}
}
}Puntos de conexión remotos
https://keycrm.usefulapi.io/mcpstreamable-httpQué puede hacer
Inventario de herramientas
Herramientas (15)
🟢keycrm_list_orders(page, limit, include, sort, status_id, ...)
List orders with filters. For unfulfilled orders, first call keycrm_list_order_statuses, then pass the status id here. Use include=buyer,products.offer,status to get the customer and products in one call. One page per call; keyCRM allows 20 requests per minute per key. GET /order.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
},
"include": {
"description": "Comma-separated related objects to load, e.g. buyer,products.offer,status,manager,payments,shipping.lastHistory. Empty = none.",
"type": "string"
},
"sort": {
"description": "Sort field as keyCRM accepts it, e.g. id.",
"type": "string"
},
"status_id": {
"description": "Filter by order status id (from keycrm_list_order_statuses).",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"source_id": {
"description": "Filter by order source id (from keycrm_list_order_sources).",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"source_uuid": {
"description": "Filter by the order id in the source system.",
"type": "string"
},
"buyer_email": {
"description": "Filter by buyer email.",
"type": "string"
},
"buyer_phone": {
"description": "Filter by buyer phone.",
"type": "string"
},
"created_between": {
"description": "Date range in UTC, \"YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM:SS\" (start, end).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?, ?\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?$"
},
"updated_between": {
"description": "Date range in UTC, \"YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM:SS\" (start, end).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?, ?\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?$"
},
"shipping_between": {
"description": "Date range in UTC, \"YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM:SS\" (start, end).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?, ?\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?$"
},
"payment_status": {
"description": "Payment status: paid, overpaid, part_paid, not_paid (comma-separated allowed).",
"type": "string",
"pattern": "^(paid|overpaid|part_paid|not_paid)(,(paid|overpaid|part_paid|not_paid))*$"
},
"has_tracking_code": {
"description": "true = orders with a shipping tracking code; false = without.",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_get_order(order_id, include)
Get one order by id, with its products, buyer, status, payments and shipping when included. GET /order/{id}.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Numeric keyCRM id."
},
"include": {
"description": "Comma-separated related objects to load, e.g. buyer,products.offer,status,payments,shipping.lastHistory,expenses. Empty = none.",
"type": "string"
}
},
"required": [
"order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_list_order_statuses(page, limit)
List the active order statuses with their ids and names. Call this first to find the status id for unfulfilled or new orders. GET /order/status.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_list_order_sources(page, limit)
List order sources (sales channels) with their ids. GET /order/source.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_list_order_tags(page, limit)
List order tags with their ids, for keycrm_add_order_tag and keycrm_remove_order_tag. GET /order/tag.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_list_buyers(page, limit, include, buyer_id, buyer_phone, ...)
List buyers (customers) with filters by id, phone, email or date. Use include=company,manager,loyalty for related data. GET /buyer.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
},
"include": {
"description": "Comma-separated related objects to load, e.g. company,manager,shipping,loyalty,custom_fields. Empty = none.",
"type": "string"
},
"buyer_id": {
"description": "Filter by buyer id or ids.",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"buyer_phone": {
"description": "Filter by buyer phone.",
"type": "string"
},
"buyer_email": {
"description": "Filter by buyer email.",
"type": "string"
},
"created_between": {
"description": "Date range in UTC, \"YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM:SS\" (start, end).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?, ?\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?$"
},
"updated_between": {
"description": "Date range in UTC, \"YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM:SS\" (start, end).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?, ?\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?$"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_get_buyer(buyer_id, include)
Get one buyer (customer) by id. GET /buyer/{id}.
Esquema de entrada
{
"type": "object",
"properties": {
"buyer_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Numeric keyCRM id."
},
"include": {
"description": "Comma-separated related objects to load, e.g. company,manager,shipping,loyalty,custom_fields. Empty = none.",
"type": "string"
}
},
"required": [
"buyer_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_list_products(page, limit, include, product_id, category_id, ...)
List catalog products with filters by id, category or archive status. Use include=custom_fields for custom fields. GET /products.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
},
"include": {
"description": "Comma-separated related objects to load, e.g. custom_fields. Empty = none.",
"type": "string"
},
"product_id": {
"description": "Filter by product id or ids.",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"category_id": {
"description": "Filter by category id or ids.",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"is_archived": {
"description": "true = archived products only; false = active only.",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_get_product(product_id, include)
Get one catalog product by id. GET /products/{id}.
Esquema de entrada
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Numeric keyCRM id."
},
"include": {
"description": "Comma-separated related objects to load, e.g. custom_fields. Empty = none.",
"type": "string"
}
},
"required": [
"product_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_list_offers(page, limit)
List product variants (offers) with their ids and SKUs. GET /offers.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_list_stock_levels(page, limit, offers_id, offers_sku, details)
List stock levels per product variant. Set details=true to get the stock per warehouse. GET /offers/stocks.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
},
"offers_id": {
"description": "Filter by variant id or ids.",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"offers_sku": {
"description": "Filter by variant SKU or SKUs (comma-separated).",
"type": "string"
},
"details": {
"description": "true = stock per warehouse instead of the total.",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_list_pipeline_cards(page, limit, include, pipeline_id, status_id, ...)
List sales pipeline cards (deals) with filters by pipeline, status, source or date. GET /pipelines/cards.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
},
"include": {
"description": "Comma-separated related objects to load, e.g. contact.client,products,manager,status,payments,custom_fields. Empty = none.",
"type": "string"
},
"pipeline_id": {
"description": "Filter by pipeline id or ids.",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"status_id": {
"description": "Filter by pipeline status id or ids.",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"source_id": {
"description": "Filter by source id or ids.",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"created_between": {
"description": "Date range in UTC, \"YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM:SS\" (start, end).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?, ?\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?$"
},
"updated_between": {
"description": "Date range in UTC, \"YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM:SS\" (start, end).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?, ?\\d{4}-\\d{2}-\\d{2}(?: \\d{2}:\\d{2}:\\d{2})?$"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢keycrm_list_users(page, limit, user_id, full_name, role_id, ...)
List team users (managers) with their ids, roles and status. Match a user id to the manager of an order from keycrm_list_orders with include=manager. GET /users.
Esquema de entrada
{
"type": "object",
"properties": {
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page, 1 to 50 (default 15). One page per call.",
"type": "integer",
"minimum": 1,
"maximum": 50
},
"user_id": {
"description": "Filter by user id or ids.",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"full_name": {
"description": "Filter by full name.",
"type": "string"
},
"role_id": {
"description": "Filter by role id or ids.",
"type": "string",
"pattern": "^\\s*\\d+\\s*(,\\s*\\d+\\s*)*$"
},
"status": {
"description": "Filter by user status.",
"type": "string",
"enum": [
"active",
"pending",
"blocked"
]
},
"email": {
"description": "Filter by email.",
"type": "string"
},
"phone": {
"description": "Filter by phone.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴keycrm_add_order_tag(order_id, tag_id)
WRITE: add an existing tag to an order. Changes the order in the customer's keyCRM account. Get tag ids from keycrm_list_order_tags. POST /order/{id}/tag/{tag_id}.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Numeric keyCRM id."
},
"tag_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Numeric keyCRM id."
}
},
"required": [
"order_id",
"tag_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴keycrm_remove_order_tag(order_id, tag_id)
WRITE: remove a tag from an order in the customer's keyCRM account. The tag itself is kept. DELETE /order/{id}/tag/{tag_id}.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Numeric keyCRM id."
},
"tag_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Numeric keyCRM id."
}
},
"required": [
"order_id",
"tag_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Comunidad
Evidencia