Lerian MCP Server
Fornece conteúdo educacional, informações sobre modelos e interações de API somente leitura para desenvolvedores Lerian.
Documentação
Servidor MCP Lerian
Um gateway MCP para descoberta do portfólio Lerian, documentação, aprendizado, exemplos de SDK, acesso à API de produtos ao vivo e fluxos de trabalho entre produtos.
Este servidor conecta clientes MCP como Claude Desktop, Cursor, Windsurf, Continue e ChatGPT Desktop ao portfólio de produtos Lerian. Ele oferece aos assistentes de IA uma maneira estruturada de descobrir produtos Lerian, ler documentação oficial, gerar exemplos de implementação, inspecionar contratos de API ao vivo, executar APIs de produtos configuradas e orientar fluxos de trabalho operacionais entre produtos.
Escopo em tempo de execução: este servidor não é apenas documentação. A ferramenta unificada
leriané orientada à leitura, mas as ferramentas específicas de produto*-executepodem chamar APIs Lerian ao vivo configuradas. Chamadas de API mutáveis exigem confirmação explícita e um motivo de auditoria.
Configuração em 2 Minutos
- Escolha seu assistente de IA compatível com MCP.
- Adicione a configuração do servidor.
- Reinicie o aplicativo de IA.
- Pergunte: "O que você pode me dizer sobre o Lerian Midaz?"
Claude Desktop
Localização no macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Localização no Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"lerian": {
"command": "npx",
"args": ["-y", "@lerianstudio/lerian-mcp-server@latest"]
}
}
}
Cursor, Windsurf, Continue, ChatGPT Desktop
Adicione o mesmo bloco de servidor MCP à configuração MCP do seu cliente:
{
"mcpServers": {
"lerian": {
"command": "npx",
"args": ["-y", "@lerianstudio/lerian-mcp-server@latest"]
}
}
}
O Que Você Obtém
Produtos Suportados
- Midaz: razão contábil de partidas dobradas unificada — organizações, razões, contas, saldos, transações e CRM em um único serviço.
- Fetcher: conexão de fontes de dados, descoberta de esquemas e serviço de extração assíncrona.
- Reporter: geração de relatórios baseada em modelos, gerenciamento de fontes de dados, métricas e artefatos.
- Matcher: mecanismo de conciliação para corresponder transações Midaz contra sistemas externos.
- Tracer: mecanismo de validação de transações com regras, limites, validações e auditabilidade.
- Flowker: plataforma de orquestração de fluxos de trabalho para provedores, executores, webhooks e fluxos de execução.
- Underwriter: superfície de empréstimos ciente de jurisdição para produtos de empréstimo e pré-visualização de cronogramas.
- All: descoberta em todo o portfólio, pesquisa de documentação e comparação.
Capacidades Principais
- Descoberta de portfólio por meio de
leriancomoperation="discover". - Consulta de documentação por meio de
leriancomoperation="docs". - Aprendizado guiado por meio de
leriancomoperation="learn". - Exemplos de SDK por meio de
leriancomoperation="sdk". - Pesquisa entre produtos por meio de
leriancomoperation="search". - Descoberta de contratos de API ao vivo por meio de ferramentas específicas de produto
*-discover. - Execução de API ao vivo por meio de ferramentas específicas de produto
*-execute. - Fluxos de trabalho entre produtos por meio de
portfolio-workflow. - Orientação baseada em prompts para integração, aprendizado, uso de API e fluxos de trabalho operacionais.
Superfície de Ferramentas em Tempo de Execução
O servidor expõe um núcleo pequeno mais pares de API ao vivo para cada produto suportado.
Ferramentas Principais
lerian: ferramenta de portfólio unificada para documentação, aprendizado, exemplos de SDK, descoberta e pesquisa.portfolio-workflow: descoberta de fluxos de trabalho entre produtos, planejamento, sessões com estado e execução de etapas.
Ferramentas de API ao Vivo
midaz-discoveremidaz-executefetcher-discoverefetcher-executereporter-discoverereporter-executematcher-discoverematcher-executetracer-discoveretracer-executeflowker-discovereflowker-executeunderwriter-discovereunderwriter-execute
Use a ferramenta *-discover correspondente antes de chamar uma ferramenta *-execute. A descoberta retorna recursos, ações, parâmetros de caminho, parâmetros de consulta, esquemas de corpo, exemplos e dicas de execução.
A Ferramenta lerian
A ferramenta lerian é o principal ponto de entrada orientado à leitura.
Tool: lerian
Parameters:
product midaz | fetcher | reporter | matcher | tracer | flowker | underwriter | all
operation discover | docs | learn | sdk | search
topic Topic to inspect, learn, or search
language go | typescript | javascript, for SDK examples
useCase Specific implementation scenario for SDK examples
experienceLevel beginner | intermediate | advanced
format summary | detailed | examples-only
includeExamples true | false
maxResults 1-50, for search
Exemplo:
{
"product": "midaz",
"operation": "learn",
"topic": "transactions",
"experienceLevel": "beginner"
}
Fluxo de Trabalho de API ao Vivo
O acesso à API ao vivo é intencionalmente em duas etapas.
- Inspecione a superfície do produto:
{
"intent": "list-resources"
}
- Inspecione o contrato de uma ação específica:
{
"intent": "describe-action",
"resource": "transactions",
"action": "create"
}
- Execute com o contrato exato retornado pela descoberta:
{
"resource": "transactions",
"action": "create",
"pathParams": {
"organizationId": "...",
"ledgerId": "..."
},
"body": {
"description": "Example transaction"
},
"confirmMutation": true,
"mutationReason": "Create example transaction requested by operator"
}
Ações de API ao vivo mutáveis exigem:
confirmMutation: truemutationReasoncom um motivo de auditoria legível por humanos
Fluxos de Trabalho Entre Produtos
Use portfolio-workflow quando a tarefa abranger vários produtos Lerian.
Fluxos de trabalho atuais:
fetcher-to-reporter: valide mapeamentos de extração com Fetcher e, em seguida, gere ou inspecione relatórios Reporter.matcher-to-fetcher-to-midaz: configure a conciliação Matcher, use a descoberta Matcher sobre Fetcher e inspecione os dados do lado do razão Midaz.
Intenções suportadas:
list-workflowsdescribe-workflowplancreate-sessionget-sessionlist-sessionsexecute-stepexecute-next
As sessões de fluxo de trabalho retornam um sessionToken opaco. Mantenha-o privado.
Configuração
O servidor funciona imediatamente para documentação e descoberta. A execução de API ao vivo exige serviços de produto acessíveis e, quando aplicável, tokens ou chaves de API.
Fontes de configuração, em ordem de prioridade:
--configou--config-filede linha de comando- Variáveis de ambiente
./lerian-mcp-config.json./midaz-mcp-config.json~/.lerian/mcp-config.json~/.midaz/mcp-config.json~/.config/lerian/mcp-config.json~/.config/midaz/mcp-config.json- Caminhos de configuração global da plataforma
Crie ou atualize a configuração interativamente:
npx -y -p @lerianstudio/lerian-mcp-server@latest lerian-mcp-config
Midaz é um serviço de razão unificado único acessado por meio de uma URL base. Integração, contas, saldos, transações e CRM são todos recursos desse único serviço, portanto há exatamente uma URL Midaz a configurar.
Variáveis de ambiente comuns:
LERIAN_DOCS_URL=https://docs.lerian.studio
LOG_LEVEL=info
MIDAZ_BASE_URL=http://localhost:3002
MIDAZ_AUTH_TOKEN=...
MIDAZ_API_TIMEOUT=30000
FETCHER_MANAGER_URL=http://localhost:4006
FETCHER_AUTH_TOKEN=...
REPORTER_MANAGER_URL=http://localhost:4005
REPORTER_AUTH_TOKEN=...
MATCHER_BASE_URL=http://localhost:4018
MATCHER_AUTH_TOKEN=...
TRACER_BASE_URL=http://localhost:4020
TRACER_API_KEY=...
FLOWKER_BASE_URL=http://localhost:4021
FLOWKER_AUTH_TOKEN=...
FLOWKER_API_KEY=...
UNDERWRITER_BASE_URL=http://localhost:8080
UNDERWRITER_AUTH_TOKEN=...
Migrando para 4.0.0
Mudança significativa: configuração do Midaz. Versões anteriores à 4.0.0 esperavam quatro URLs Midaz separadas, uma por serviço legado (integração, transação, CRM, razão). Essas variáveis não existem mais — elas não são lidas nem aceitas. Aponte MIDAZ_BASE_URL para seu razão Midaz unificado e mantenha MIDAZ_AUTH_TOKEN como está. Nada mais na configuração mudou.
Modelo de Segurança
- A execução ao vivo é opcional por meio de ferramentas específicas de produto
*-execute. - Métodos mutáveis exigem confirmação explícita e um motivo de mutação.
- As URLs base da API do produto devem usar
httpouhttps. - URLs HTTP fora de localhost são rejeitadas; HTTPS é obrigatório fora do desenvolvimento local.
- URLs com credenciais incorporadas são rejeitadas.
- Cabeçalhos de autorização e chave de API são protegidos contra substituição arbitrária.
- Os tamanhos de upload e download binário são limitados por limites configuráveis.
- Segredos são gerados e gerenciados localmente sob
~/.lerian/secrets.jsonquando necessário.
Exemplos de Conversas
Descoberta de Portfólio
Você: "Com quais produtos Lerian este MCP pode ajudar?"
IA: Usa lerian com product="all", operation="discover".
Caminho de Aprendizado
Você: "Sou novo no Tracer. Ensine-me como funcionam as regras de validação."
IA: Usa lerian com product="tracer", operation="learn", topic="rules".
Exemplo de SDK
Você: "Mostre-me código Go para criar um razão Midaz."
IA: Usa lerian com product="midaz", operation="sdk", language="go".
Descoberta de Contrato de API ao Vivo
Você: "Inspecione o contrato para criar um modelo Reporter."
IA: Usa reporter-discover antes de qualquer chamada reporter-execute.
Fluxo de Trabalho Entre Produtos
Você: "Oriente-me na validação de mapeamentos Fetcher antes de gerar um relatório."
IA: Usa portfolio-workflow com workflow="fetcher-to-reporter".
Desenvolvimento
Requer Node.js >=20.19.0.
npm ci
npm run build
npm test
Scripts úteis:
npm run dev: executa o ponto de entrada TypeScript comts-node.npm run build: compila paradist/e marca os binários como executáveis.npm run lint: executa ESLint.npm run typecheck: executa TypeScript sem emitir arquivos.npm test: executa testes Node mais o teste básico do servidor.npm run docs: gera saída TypeDoc emdocs/.
Documentação
- Documentação Completa
- Caminhos de Aprendizado
- Referência do SDK
- Solução de Problemas
- Índice de Mídia e Diagramas
- Instruções do Agente
Informações do Pacote
- Pacote npm:
@lerianstudio/lerian-mcp-server— a página npm e os lançamentos do GitHub trazem a versão atual e o changelog. - Tempo de execução: Node.js ESM
- Transporte: somente stdio
- Licença: Apache-2.0
- Repositório: github.com/lerianstudio/lerian-mcp-server
Resumo da Arquitetura
MCP Client
-> stdio transport
-> MCP server runtime
-> core tools and prompts
-> product adapters
-> product routers and schema registries
-> configured Lerian product APIs
Camadas principais:
- Transporte: MCP JSON-RPC sobre stdio.
- Inicialização do servidor: segurança, segredos, manifesto de documentação, registro, detecção de cliente.
- Ferramentas principais:
lerianeportfolio-workflow. - Adaptadores de produto: pares descobrir/executar para produtos suportados.
- Registros de esquema: contratos de recurso/ação para superfícies de API.
- Execução HTTP: construção de URL validada, execução de solicitação, análise de resposta e classificação de erros.
- Orquestração de fluxo de trabalho: fluxos guiados entre vários produtos com estado.
Solução de Problemas
Servidor Não Inicia
Verifique a versão do Node.js:
node --version
Execute manualmente:
npx -y @lerianstudio/lerian-mcp-server@latest
Verifique segredos locais:
ls -la ~/.lerian/secrets.json
Chamadas de API ao Vivo Falhando
- Use a ferramenta
*-discoverdo produto primeiro. - Verifique se a URL base e o token/chave de API relevantes estão configurados.
- Confirme que URLs remotas fora de localhost usam HTTPS.
- Para mutações, inclua
confirmMutation=trueemutationReason. - Verifique se o serviço do produto de destino está acessível a partir do tempo de execução MCP.
Ferramenta Não Respondendo no Cliente
- Reinicie o cliente MCP após alterações de configuração.
- Confirme que o MCP está habilitado no cliente.
- Ative o registro com
LOG_LEVEL=debugse necessário. - Verifique
./logs/quando o registro estiver habilitado.