> ## Documentation Index > Fetch the complete documentation index at: https://docs.indiqai.com/llms.txt > Use this file to discover all available pages before exploring further. # Catálogo de tools > Todas as tools públicas do MCP IndiqAI, com rota, uso e retorno principal # Catálogo de tools Esta página resume as tools públicas do MCP do IndiqAI. O catálogo completo atual tem **25 tools autenticadas**. Todas as rotas abaixo usam a base `https://api.indiqai.com/api/v1/public`. Nas tabelas, mostramos apenas o path relativo. ## Convenções * autenticação por `X-API-Key` * tenant derivado automaticamente da chave * `X-Idempotency-Key` suportado em 3 writes críticos * resposta paginada sempre retorna `data`, `total`, `page`, `pages` e `per_page` ## Clientes e relacionamento | Tool | HTTP | O que faz | Entrega principal | | -------------------------- | ----------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------- | | `list_clients` | `GET /clients` | Lista clientes da empresa com paginação e busca | objeto paginado com `data`, `total`, `page`, `pages`, `per_page` | | `get_client` | `GET /clients/{client_id}` | Busca um cliente específico | objeto do cliente com `id`, `nome`, `email`, `telefone`, `pontos`, `created_at` | | `create_client` | `POST /clients` | Cria e vincula um cliente à empresa | objeto do cliente criado | | `get_client_behavior` | `GET /clients/{client_id}/behavior` | Resume o comportamento do cliente no período | métricas agregadas de pontos, cupons, indicações e fidelidade | | `get_client_timeline` | `GET /clients/{client_id}/timeline` | Retorna a timeline de eventos do cliente | lista de eventos com filtros de paginação/categoria | | `get_referral_performance` | `GET /referral-performance` | Resume o desempenho do programa de indicação | objeto com métricas globais ou por cliente | ## Pontos, cupons e fidelidade transacional | Tool | HTTP | O que faz | Entrega principal | | -------------------- | ------------------------------------- | ------------------------------------------- | ----------------------------------------------------------- | | `get_points_balance` | `GET /points/{client_id}` | Consulta o saldo de pontos do cliente | objeto com `client_id`, `balance` e `empresa_id` | | `credit_points` | `POST /points/credit` | Credita pontos para um cliente | saldo atualizado do cliente | | `generate_coupon` | `POST /coupons/generate` | Gera um cupom por pontos ou produto | objeto do cupom com `uid`, `status`, `valor`, `expires_at` | | `get_coupon` | `GET /coupons/{uid}` | Busca um cupom pelo identificador | objeto do cupom | | `use_coupon` | `PATCH /coupons/{uid}/use` | Marca um cupom como usado | objeto do cupom já no estado final | | `stamp_loyalty_card` | `POST /loyalty-cards/{card_id}/stamp` | Adiciona um carimbo ao progresso do cliente | objeto de progresso com `stamps`, `max_stamps`, `completed` | ## Produtos e prêmios | Tool | HTTP | O que faz | Entrega principal | | ---------------- | ---------------------------- | ---------------------------------------- | ---------------------------- | | `list_products` | `GET /products` | Lista os produtos disponíveis da empresa | lista simples de produtos | | `create_product` | `POST /products` | Cria um produto | objeto do produto criado | | `update_product` | `PUT /products/{product_id}` | Atualiza um produto existente | objeto do produto atualizado | | `list_rewards` | `GET /rewards` | Lista recompensas disponíveis | lista simples de recompensas | ## Programas, campanhas e métricas | Tool | HTTP | O que faz | Entrega principal | | ---------------------------- | ----------------------------- | ------------------------------------------------ | ---------------------------------------------------------------- | | `list_loyalty_cards` | `GET /loyalty-cards` | Lista progressos de fidelidade | lista simples de progressos/cartões emitidos | | `get_metrics_overview` | `GET /metrics/overview` | Retorna KPIs resumidos da empresa | objeto com visão agregada de clientes, cupons, pontos e resgates | | `list_loyalty_card_programs` | `GET /loyalty-cards/programs` | Lista programas de fidelidade | lista simples de programas | | `get_loyalty_card_metrics` | `GET /loyalty-cards/metrics` | Retorna métricas de fidelidade | objeto analítico agregado por período | | `list_referral_campaigns` | `GET /referrals/campaigns` | Lista campanhas de indicação | lista simples de campanhas | | `get_referral_metrics` | `GET /referrals/metrics` | Retorna métricas de indicação | objeto analítico agregado por período | | `list_quests` | `GET /quests` | Lista quests/programas de pesquisa da empresa | lista simples de quests | | `get_quest_metrics` | `GET /quests/metrics` | Retorna métricas globais ou detalhadas de quests | objeto analítico global ou por quest | | `get_nfce_metrics` | `GET /nfce/metrics` | Retorna métricas da mecânica de NFC-e | objeto analítico com volume, conversões e recorrência | ## Writes com idempotência | Tool | Rota | Como proteger retry | | -------------------- | ------------------------------------- | ------------------------- | | `credit_points` | `POST /points/credit` | envie `X-Idempotency-Key` | | `generate_coupon` | `POST /coupons/generate` | envie `X-Idempotency-Key` | | `stamp_loyalty_card` | `POST /loyalty-cards/{card_id}/stamp` | envie `X-Idempotency-Key` | ## Observações importantes ### `create_client` * `email`, `telefone` e `cpf` são opcionais * se `email` vier ausente, o backend provisiona um identificador técnico para o fluxo interno de autenticação ### `use_coupon` * a primeira chamada muda o cupom para usado * um replay do mesmo `PATCH` tende a retornar o estado final do cupom, em vez de gerar um novo recurso ### `stamp_loyalty_card` * o `card_id` esperado aqui é o **id do progresso** retornado por `GET /loyalty-cards` * ele **não** representa o id bruto da definição do programa ### Fora do catálogo autenticado Quests públicas de resposta/claim e eventos públicos de email continuam na API pública, mas seguem contrato próprio e não usam este catálogo autenticado como referência principal. ## Próximo passo Se você vai expor essas tools em um agente, siga o guia de [Conectando clientes MCP ao IndiqAI](/api-reference/public-api/agent-integrations).