Lerian MCP Server

Fornece conteúdo educacional, informações sobre modelos e interações de API somente leitura para desenvolvedores Lerian.

GitHub

Documentação

Lerian MCP Server

Um gateway MCP para descoberta do portfólio Lerian, documentação, aprendizado, exemplos de SDK, acesso à API de produto 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 dá aos assistentes de IA uma forma estruturada de descobrir produtos Lerian, ler documentação oficial, gerar exemplos de implementação, inspecionar contratos de API ao vivo, executar APIs de produto configuradas e orientar fluxos de trabalho operacionais entre múltiplos produtos.

Escopo em runtime: este servidor não é apenas de documentação. A ferramenta unificada lerian é orientada à leitura, mas as ferramentas *-execute específicas de produto podem chamar APIs Lerian ao vivo configuradas. Chamadas de API com mutação 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 contar 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: plataforma de razão financeira com onboarding, saldos, transações, CRM e serviços de razã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 com ciência de jurisdição para produtos de crédito e pré-visualização de cronograma.
All: descoberta em todo o portfólio, pesquisa de documentação e comparação.

Capacidades Principais

Descoberta de portfólio por meio de lerian com operation="discover".
Consulta de documentação por meio de lerian com operation="docs".
Aprendizado guiado por meio de lerian com operation="learn".
Exemplos de SDK por meio de lerian com operation="sdk".
Pesquisa entre produtos por meio de lerian com operation="search".
Descoberta de contratos de API ao vivo por meio de ferramentas *-discover específicas de produto.
Execução de API ao vivo por meio de ferramentas *-execute específicas de produto.
Fluxos de trabalho entre produtos por meio de portfolio-workflow.
Orientação baseada em prompts para onboarding, aprendizado, uso de API e fluxos de trabalho operacionais.

Superfície de Ferramentas em Runtime

O servidor expõe um núcleo pequeno além de 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-discover e midaz-execute
fetcher-discover e fetcher-execute
reporter-discover e reporter-execute
matcher-discover e matcher-execute
tracer-discover e tracer-execute
flowker-discover e flowker-execute
underwriter-discover e underwriter-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 ponto de entrada principal 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 da API ao Vivo

O acesso à API ao vivo é intencionalmente feito 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 com mutação exigem:

confirmMutation: true
mutationReason com um motivo de auditoria legível por humanos

Fluxos de Trabalho Entre Produtos

Use portfolio-workflow quando a tarefa abranger múltiplos produtos Lerian.

Fluxos atuais:

fetcher-to-reporter: validar mapeamentos de extração com Fetcher e, em seguida, gerar ou inspecionar relatórios do Reporter.
matcher-to-fetcher-to-midaz: configurar conciliação do Matcher, usar a descoberta do Matcher sobre o Fetcher e inspecionar dados do lado da razão no Midaz.

Intenções suportadas:

list-workflows
describe-workflow
plan
create-session
get-session
list-sessions
execute-step
execute-next

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:

--config ou --config-file de 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

Variáveis de ambiente comuns:

LERIAN_DOCS_URL=https://docs.lerian.studio
LOG_LEVEL=info

MIDAZ_ONBOARDING_URL=http://localhost:3000
MIDAZ_TRANSACTION_URL=http://localhost:3001
MIDAZ_CRM_URL=http://localhost:3002
MIDAZ_LEDGER_URL=http://localhost:3003
MIDAZ_AUTH_TOKEN=...

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=...

Modelo de Segurança

A execução ao vivo é opcional, por meio de ferramentas *-execute específicas de produto.
Métodos com mutação exigem confirmação explícita e um motivo de mutação.
As URLs base da API de produto devem usar http ou https.
URLs HTTP que não sejam 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.json quando 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".

Trilha 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 uma razão no 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 do Reporter."

IA: Usa reporter-discover antes de qualquer chamada reporter-execute.

Fluxo de Trabalho Entre Produtos

Você: "Guie-me pela validação dos mapeamentos do 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 entrypoint TypeScript com ts-node.
npm run build: compila para dist/ 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 além do teste básico do servidor.
npm run docs: gera a saída TypeDoc em docs/.

Documentação

Informações do Pacote

Pacote npm: @lerianstudio/lerian-mcp-server
Versão atual do pacote: 3.4.0
Runtime: Node.js ESM
SDK MCP: @modelcontextprotocol/sdk
Licença: Apache-2.0
Repositório: github.com/lerianstudio/lerian-mcp-server

Resumo da Arquitetura

MCP Client
  -> stdio transport
  -> McpServer from @modelcontextprotocol/sdk
  -> core tools and prompts
  -> product adapters
  -> product routers and schema registries
  -> configured Lerian product APIs

Camadas principais:

Transporte: MCP JSON-RPC sobre stdio.
Bootstrap do servidor: segurança, segredos, manifesto de documentação, logging, detecção de cliente.
Ferramentas principais: lerian e portfolio-workflow.
Adaptadores de produto: pares discover/execute 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 requisições, parsing de respostas e classificação de erros.
Orquestração de fluxos de trabalho: fluxos entre múltiplos produtos, guiados e 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 os segredos locais:

ls -la ~/.lerian/secrets.json

Chamadas de API ao Vivo Falhando

Use a ferramenta *-discover do produto primeiro.
Verifique se a URL base e o token/chave de API relevantes estão configurados.
Confirme se URLs remotas fora de local usam HTTPS.
Para mutações, inclua confirmMutation=true e mutationReason.
Verifique se o serviço de produto de destino está acessível a partir do runtime MCP.

Ferramenta Sem Resposta no Cliente

Reinicie o cliente MCP após alterações de configuração.
Confirme que o MCP está habilitado no cliente.
Ative o logging com LOG_LEVEL=debug se necessário.
Verifique ./logs/ quando o logging estiver habilitado.

Lerian MCP Server

Documentação

Lerian MCP Server

Configuração em 2 Minutos

Claude Desktop

Cursor, Windsurf, Continue, ChatGPT Desktop

O Que Você Obtém

Produtos Suportados

Capacidades Principais

Superfície de Ferramentas em Runtime

Ferramentas Principais

Ferramentas de API ao Vivo

A Ferramenta lerian

Fluxo de Trabalho da API ao Vivo

Fluxos de Trabalho Entre Produtos

Configuração

Modelo de Segurança

Exemplos de Conversas

Descoberta de Portfólio

Trilha de Aprendizado

Exemplo de SDK

Descoberta de Contrato de API ao Vivo

Fluxo de Trabalho Entre Produtos

Desenvolvimento

Documentação

Informações do Pacote

Resumo da Arquitetura

Solução de Problemas

Servidor Não Inicia

Chamadas de API ao Vivo Falhando

Ferramenta Sem Resposta no Cliente

A Ferramenta `lerian`