Coletum MCP Server
OfficialServer Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| COLETUM_PASTA | No | Pasta dos arquivos: saídas em <pasta>/saidas e modelos em <pasta>/modelos (opcional; vazio = Documentos/Coletum). | |
| COLETUM_TOKEN | Yes | Token do Webservice V2 (obrigatória). | |
| COLETUM_INTERVALO_S | No | Intervalo mínimo, em segundos, entre o início de duas requisições (opcional; padrão 0,5). | 0.5 |
| COLETUM_PASTA_SAIDA | No | Pasta separada para saídas (opcional; vale por cima de COLETUM_PASTA). | |
| COLETUM_PASTA_MODELOS | No | Pasta separada para modelos (opcional; vale por cima de COLETUM_PASTA). | |
| COLETUM_MAX_CHAMADAS_HORA | No | Teto de chamadas por hora, janela móvel (opcional; padrão 300). | 300 |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": false
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
| experimental | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| listar_formulariosA | Lista os formulários da conta: id, nome, status, categoria e versão. Custo: 1 chamada por página, cerca de 200 bytes por formulário. Use tamanho_pagina alto (até 500) para ver tudo em 1 chamada. É o ponto de partida: o id daqui entra em todas as outras ferramentas. |
| estrutura_formularioA | Estrutura de um formulário: campos em ordem, com chave técnica, rótulo, tipo, se é múltiplo, se é obrigatório, opções dos campos de escolha, regras de exibição e grupos (repetíveis ou não). Use antes de montar planilha ou PDF: dá os rótulos legíveis, a ordem e os blocos. Custo: 1 chamada na primeira vez; depois fica guardada em memória e custa 0 enquanto o servidor roda. |
| contar_preenchimentosA | Conta quantos preenchimentos batem com os filtros, sem trazê-los. Custo: sempre 1 chamada (pede 1 preenchimento só para ler o total). Use SEMPRE antes de buscar ou exportar: devolve o total e quantas chamadas (e quanta cota, com o peso atual da v2) custaria ler tudo na conversa (páginas de tamanho_pagina) ou exportar para arquivo (páginas de 500). Filtro inválido é recusado antes de chamar a API. |
| buscar_preenchimentosA | Traz UMA página de preenchimentos em resumo compacto, para a IA ler. Cada preenchimento vem com id, data, autor, origem, coordenada do aparelho, os campos simples preenchidos (pelo rótulo), quantos itens tem cada grupo repetível e quantos anexos. Os links dos anexos e os itens dos grupos ficam de fora: para isso, use exportar_preenchimentos. Os preenchimentos vêm do mais recente para o mais antigo (data de criação). Os N mais recentes: pagina=1 e tamanho_pagina=N (1 chamada). Os mais antigos: use contar_preenchimentos e leia a última página. Custo: 1 chamada por página (a estrutura do formulário custa mais 1 na primeira vez). Para ler a próxima página, chame de novo com pagina+1 enquanto tem_proxima for verdadeiro. Para muitos preenchimentos, prefira exportar_preenchimentos. |
| exportar_preenchimentosA | Exporta os preenchimentos filtrados para planilha no disco, no mesmo padrão da exportação do Coletum. Sem ajustes, o arquivo é o que o cliente já conhece: aba LEIA-ME, aba do formulário (1 linha por preenchimento, código, campos, contagem dos grupos e das fotos, metadados no fim) e uma aba por grupo repetível ou campo com várias respostas, ligadas pelos códigos (1.2, 1.2.0, 1.2.0.1) e por links internos. O CSV é o mesmo conjunto em arquivos: ponto e vírgula, vírgula decimal, UTF-8 com BOM. Com ajustes: escolher campos, aba única (modo linhas ou colunas), metadados no começo ou fora, rótulos, CSV com vírgula e ponto, extras. Ajuste inválido é recusado antes de ler os preenchimentos. Custo: 1 chamada por página de 500, mais 1 pela estrutura na primeira vez. Para em max_paginas e avisa se ficou preenchimento de fora. Devolve só o caminho, o link, as contagens e o consumo da cota, nunca o conteúdo (CSV: o link da pasta e o de cada arquivo). Rode contar_preenchimentos antes para saber quantas chamadas vai gastar. Ao terminar, sempre mostre ao usuário o caminho completo de cada arquivo (vem no começo da resposta e em mostrar_ao_usuario), em bloco de código, para ele copiar; se ele pedir para abrir, use mostrar_arquivo. Nunca diga só 'na pasta do projeto'. |
| gerar_pdf_preenchimentoA | Gera PDF de preenchimentos. O PDF padrão é o da exportação do Coletum (modelo coletum_exportacao, o mesmo de gerar_pdf_modelo); a resposta traz modelo e layout. Os ajustes pedidos na conversa ("põe meu logo", "tira o campo X", "uma foto por linha", fonte, cor de destaque, página deitada) valem NO PRÓPRIO modelo do Coletum: o visual continua o da exportação. modelo=coletum_colunas para "em colunas" ou "compacto" (pergunta | resposta); modelo=coletum_fotografico para "relatório fotográfico" ou "só as fotos". Se o pedido tem um ajuste que nenhum dos três faz (ver ajustes), a ferramenta recusa e diz quais ajustes não existem, sem gerar outro visual: avise o cliente e ofereça o modelo dele (analisar_pdf_modelo e gerar_pdf_modelo). Escolha: (1) preenchimentos com id e criado_em (de buscar_preenchimentos); (2) ids_preenchimentos com um período; (3) só filtros, até max_preenchimentos. Na escolha (3) entram os mais recentes, porque a API devolve do mais recente para o mais antigo: "PDF dos 5 últimos" = sem filtro e max_preenchimentos=5 (1 chamada); para mostrar a lista antes, buscar_preenchimentos com pagina=1 e tamanho_pagina=5 e passe id e criado_em. Por padrão sai um PDF com todos, cada preenchimento em página nova; modo=um_por_preenchimento gera um arquivo para cada. As fotos são baixadas pelo link direto do armazenamento, sem passar pela conversa; se o link não responde, entra um quadro "foto indisponível". Custo: 1 chamada por janela de busca (ids com datas próximas dividem a mesma janela) ou 1 por página de filtro, mais 1 pela estrutura na primeira vez. Baixar fotos não gasta cota, mas gera tráfego para o Coletum (até 200 fotos por chamada). Devolve só caminhos, links, páginas e contagens, nunca o conteúdo (vários arquivos: o link de cada um e o da pasta). Ao terminar, sempre mostre ao usuário o caminho completo de cada arquivo (vem no começo da resposta e em mostrar_ao_usuario), em bloco de código, para ele copiar; se ele pedir para abrir, use mostrar_arquivo. Nunca diga só 'na pasta do projeto'. |
| analisar_pdf_modeloA | Analisa o PDF modelo do cliente para replicar o layout num template Typst. Devolve JSON compacto (tamanho da página em mm, margens estimadas, linhas de texto com posição, fonte, tamanho, estilo e cor, cores dominantes do texto, das áreas preenchidas e das linhas, imagens embutidas com posição e tamanho) E as páginas renderizadas como imagem, para você ver o layout. As imagens embutidas são salvas em disco (candidatas a logo, com o caminho) para usar em gerar_pdf_modelo e salvar_modelo (arquivos). Foto do papel: só a imagem, sem texto extraído. Só lê o arquivo indicado. Não chama a API. |
| gerar_pdf_modeloA | Gera PDF de um ou vários preenchimentos a partir de um template Typst (modelo salvo, arquivo .typ ou texto). Os modelos do Coletum (coletum_exportacao, o PDF padrão; coletum_colunas; coletum_fotografico) saem mais simples por gerar_pdf_preenchimento. Aqui entram o modelo do cliente e o template em teste; aparencia leva os mesmos ajustes (campos, fotos por linha, fonte, cor de destaque, orientação) para os modelos que a leem. Monta a pasta do trabalho (dados.json no contrato versão 1, fotos já baixadas, arquivos e fontes do modelo, coletum.typ) e compila com o Typst, com a raiz nessa pasta: o template não lê nada fora dela e não baixa pacotes. Erro de compilação volta com a mensagem do Typst, linha e coluna, para corrigir o template e gerar de novo. Escolha dos preenchimentos igual à de gerar_pdf_preenchimento (só com filtros, entram os mais recentes: "os 5 últimos" = max_preenchimentos=5). Com comparar_com, devolve a imagem lado a lado para comparar com o modelo do cliente. Salve o modelo aprovado com salvar_modelo e depois gere só pelo nome. Custo: 1 chamada por janela de busca ou página de filtro, mais 1 pela estrutura na 1ª vez; fotos não gastam cota. Links: o de cada PDF (com mais de um, também o da pasta) e o do lado a lado. Ao terminar, sempre mostre ao usuário o caminho completo de cada arquivo (vem no começo da resposta e em mostrar_ao_usuario), em bloco de código, para ele copiar; se ele pedir para abrir, use mostrar_arquivo. Nunca diga só 'na pasta do projeto'. |
| salvar_modeloA | Salva um modelo de PDF na máquina do cliente, para reusar só pelo nome em gerar_pdf_modelo. Grava // com modelo.typ, modelo.json (descrição, formulários, mapeamento, datas), arquivos/ e fontes/. Não sobrescreve sem substituir=true. Modelos embutidos não podem ser trocados. Não chama a API. |
| listar_modelosA | Lista os modelos de PDF disponíveis: os salvos na pasta de modelos do cliente e os embutidos (somente leitura: coletum_exportacao, que replica o PDF da exportação do Coletum, e os alternativos coletum_colunas e coletum_fotografico, com aparencia_aceita). Diz também se há preferências salvas. Com mostrar_template, traz o texto de um modelo para ajustar e salvar com outro nome. Não chama a API. |
| ler_preferenciasA | Lê as preferências do cliente salvas (quem lê os documentos, para quê, frequência, identidade visual, o que nunca aparece, formato preferido). Leia no começo de qualquer tarefa de documento para não perguntar de novo. Não chama a API. |
| salvar_preferenciasA | Salva as preferências do cliente em preferencias.md, na pasta de modelos, para as próximas conversas. Não chama a API. |
| mostrar_arquivoA | Abre a pasta do sistema com o arquivo selecionado (Finder no Mac, Explorer no Windows; no Linux abre a pasta), para o usuário achar o que o conector gerou. Use quando ele pedir para abrir o arquivo ou a pasta. Só abre o que está na pasta de saída do conector ou o que alguma ferramenta gerou nesta conversa. Não chama a API. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| coletum-pdf | Gera PDF de preenchimentos de um formulário do Coletum, no padrão do PDF da exportação, com ajustes pedidos na conversa (logo, campos, fotos por linha, cor, página deitada) ou em colunas ou fotográfico. Use quando o cliente pedir PDF, ficha, laudo, relatório fotográfico ou documento para imprimir ou enviar a partir dos dados do Coletum. |
| coletum-pdf-no-modelo | Gera o PDF dos preenchimentos do Coletum no layout que o cliente já usa (documento da empresa, laudo, relatório de vistoria), a partir de um PDF ou foto do modelo dele. Use quando o cliente disser que quer no modelo dele, igual ao documento que a empresa usa ou no layout de um arquivo que ele mandar. |
| coletum-planilha | Exporta preenchimentos de um formulário do Coletum para Excel ou CSV no padrão da exportação do sistema, ou num formato pedido pelo cliente. Use quando o cliente pedir planilha, Excel, CSV, exportar os dados ou levar os dados para Power BI, R ou outro sistema. |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 13 tools
Most tools target distinct resources and actions (list forms, get structure, count/search/export submissions, manage templates). The two PDF generators (gerar_pdf_preenchimento vs gerar_pdf_modelo) share the same action (generate PDF) and could be confused, but descriptions clarify that one uses built-in Coletum models and the other uses custom Typst templates.
Almost all names follow a clear verb_noun pattern in Portuguese (listar_formularios, buscar_preenchimentos, gerar_pdf_modelo, etc.). One outlier 'estrutura_formulario' is noun_noun, breaking the pattern slightly, but the set remains highly readable and predictable.
13 tools is well within the ideal 3-15 range and each tool earns its place: form listing, structure retrieval, submission counting/search/export, two PDF generation paths, model analysis/saving, and preference management. No redundant or trivial tools.
The surface covers the core workflows: listing forms, getting structure, counting/searching/exporting submissions, generating PDFs via built-in or custom templates, analyzing/saving templates, and managing preferences. A minor gap is the lack of a tool to fetch full submission details (including group items and attachment links) directly in-conversation, as that requires exporting to disk.