Saltar al contenido principal

Tools

El servidor expone 292 tools sobre 25 familias de recurso. Cada una despacha in-process al endpoint de /v1 que ya implementa la operación, así que filtros, validación, reglas de upsert y aislamiento por organización son exactamente los de la API REST — la tool es el endpoint. La única excepción, billing_schemas_get, responde localmente y está marcada como tal.

Cómo leer estas páginas​

Cada tool aparece con cuatro datos, en este orden:

billing_invoices_void · destructive · recurso invoices · permiso invoices.void · POST /v1/invoices/:id/void

CampoSignificado
read / write / destructiveLa anotación que lee el cliente MCP. En una destructive pide confirmación al usuario.
recursoLa familia de recurso de la tool — lo que agrupa las tools en esta documentación.
permisoEl permiso de panel que la persona que autorizó el cliente debe tener en la organización.
MÉTODO /rutaEl endpoint de /v1 al que despacha la tool, para cruzar con la Referencia de la API.

Argumentos comunes​

Aparecen en muchas tools y siempre significan lo mismo.

ArgumentoTipoDescripción
pageenteroPágina, desde 1. Predeterminado 1.
per_pageenteroÍtems por página. Predeterminado 20, máximo 100.
sort_bystringColumna de orden, en snake_case. Los aceptados están en billing_schemas_get.
sort_orderasc | descDirección. Un valor que no es dirección es un error, no un desc silencioso.
fieldsstring[]Columnas a devolver. Omitido, vuelve el recurso entero; id siempre vuelve.
filtersobjectFiltros adicionales, reenviados verbatim al endpoint.
idempotency_keystringProtección contra reintentos, enviada como X-Idempotency-Key.
custom_metadataobjectJSON libre tuyo, devuelto en cada lectura y en cada webhook.
FamiliaToolsreadwritedestructive
certificates — Certificados digitales3201
companies — Empresas emisoras12462
coupons — Cupones y códigos de descuento8341
credits — Créditos7331
customers — Clientes y cuentas de cobro19694
invoices — Facturas238114
nfes — Notas fiscales (NF-e)248133
payments — Pagos y métodos de pago194114
plan-changes — Cambios de plan11641
plans — Planes, precios y grupos205123
portal-users — Usuarios del portal9441
products — Productos y grupos de productos244173
proposals — Propuestas257117
roles — Roles del equipo6231
services — Ítems de servicio6231
settings — Organización y esquemas3210
subscription-changes — Cambios de suscripción5311
subscriptions — Suscripciones16484
tax-periods — Períodos de cálculo5221
tax-rules — Reglas fiscales6231
templates — Plantillas de propuesta9261
transfer-destinations — Cuentas bancarias y claves Pix11542
usage — Consumo medido7430
users — Usuarios del panel6231
withholdings — Retenciones8251

Una tool que no puedes ejecutar no aparece en tools/list. Si falta alguna de esta página, ve Autenticación.