Pular para o conteúdo principal
O Lerian MCP conecta seu assistente de IA diretamente ao ecossistema Midaz. Seja usando ChatGPT, Claude, Cursor, Windsurf ou outro client compatível, este servidor dá ao seu Large Language Model (LLM) acesso seguro e em tempo real à documentação, APIs e até serviços locais do Midaz. É como dar ao seu assistente conhecimento interno — para que ele possa ler a documentação, gerar código, executar ações e ajudar você a avançar mais rápido.

​
O que é MCP?

MCP significa Model Context Protocol. Pense nele como o Bluetooth para LLMs: é como sua IA aprende quais ferramentas pode usar, como seu sistema funciona e quais perguntas fazer para concluir o trabalho. O Lerian MCP ensina seu assistente a:
  • Entender documentação, arquitetura e SDKs.
  • Usar APIs através de ferramentas integradas.
  • Se auto-orientar de forma inteligente com perguntas de acompanhamento.
Uma vez conectado, seu assistente se torna consciente do contexto e capaz de agir.

​
Por que usar o Lerian MCP?

O Lerian MCP transforma seu assistente de IA em um companheiro de desenvolvimento produtivo. Ele ajuda você a:
  • Pesquisar na documentação do Midaz com linguagem natural.
  • Chamar APIs locais do Midaz usando ferramentas (não apenas texto estático).
  • Entender a arquitetura, endpoints e SDKs do Midaz.
  • Gerar código, resolver problemas e automatizar a configuração.
  • Manter tudo local e com permissões explícitas.
Seja construindo novas integrações ou dando suporte a sistemas em produção, este plugin fornece ao seu LLM o contexto necessário, de forma segura e instantânea.

​
Construído para segurança

A segurança está incorporada em cada etapa. O Lerian MCP:
  • Roda inteiramente na sua máquina.
  • Tem acesso somente leitura por padrão.
  • Requer aprovação explícita do usuário antes de gravar dados.
  • Não precisa de API keys para configuração local.
  • É Código Aberto e auditável.
Seus dados ficam onde devem — sob seu controle.

​
O que seu assistente pode fazer?

Uma vez conectado, seu assistente pode interagir com seu ambiente Midaz como se já tivesse lido a documentação. Ele pode:
  • Explicar como conceitos do Midaz funcionam.
  • Gerar código para tarefas do mundo real (ex.: criar uma organização).
  • Pesquisar e resumir endpoints de API.
  • Ajudar a depurar problemas de integração.
  • Explorar a arquitetura e SDKs disponíveis.
  • Executar ferramentas pré-configuradas para chamar seus serviços de API locais.

​
Exemplos do que você pode perguntar

  • “Como eu crio uma transação no Midaz?”
  • “Me mostre o código Go para fazer o onboarding de uma organização.”
  • “Qual a diferença entre as APIs de onboarding e de transações?”
  • “Me ajude a resolver esse erro 400.”
  • “Liste todos os tipos de conta do Midaz.”
É como conversar com um colega que sempre tem a resposta e o exemplo certo prontos.

​
Ferramentas e prompts disponíveis

O Lerian MCP fornece ao seu assistente um kit de ferramentas abrangente para explorar documentação, interagir com APIs e aprender através de orientação prática. Tudo roda localmente, de forma segura e consciente do contexto.

​
Acesso completo à documentação (midaz-docs)

​
Operações disponíveis

  • getting-started: Introdução ao Midaz.
  • api-reference: Documentação detalhada da API.
  • search-endpoints: Pesquisa por endpoint ou função.
  • best-practices: Melhores práticas de segurança, desempenho e modelagem.
  • architecture: Visão geral da arquitetura do sistema.
  • sdk-docs: Documentação oficial dos SDKs.
  • code-examples: Geração de exemplos de código.
  • workflows: Padrões comuns de workflow.
  • troubleshooting: Guias de resolução de problemas e diagnóstico.
  • search: Pesquisa geral na documentação.
  • sitemap: Estrutura completa da documentação.
  • read: Acesso direto a uma página específica.
  • browse: Navegação guiada pela documentação.

​
Ferramentas de aprendizado guiado (midaz-learn)

​
Tipos de conteúdo disponíveis

  • path: Caminhos de aprendizado personalizados.
  • tutorial: Tutoriais passo a passo.
  • concept: Explicações detalhadas de conceitos.
  • search: Pesquisa rápida em materiais de aprendizado.

​
Operações de domínio

​
Organizations

  • list-organizations: Lista todas as organizações.
  • get-organization: Obtém detalhes de uma organização específica.

​
Ledgers

  • list-ledgers: Lista todos os ledgers de uma organização.
  • get-ledger: Obtém detalhes de um ledger específico.

​
Accounts

  • list-accounts: Lista todas as contas de um ledger.
  • get-account: Obtém detalhes de uma conta.
  • get-balance: Consulta o saldo de uma conta.

​
Transactions

  • list-transactions: Lista todas as transações.
  • get-transaction: Obtém detalhes de uma transação.

​
SDK

  • generate-sdk-code: Gera código usando os SDKs oficiais.
  • compare-sdk-features: Compara funcionalidades entre SDKs.
  • find-sdk-examples: Pesquisa exemplos de código específicos.

​
Prompts disponíveis

Seu assistente também entende uma ampla gama de prompts integrados que adaptam o conteúdo ao nível de experiência, tempo disponível ou role do usuário.

​
Documentação

  • Formato: detailed, summary, examples-only.
  • Categorias: api, guides, examples, models, components.

​
Aprendizado

  • Nível de experiência: beginner, intermediate, advanced.
  • Modo de aprendizado: explain, show-me, guide-me, deep-dive.
  • Tempo disponível: 5min, 15min, 30min, 1hour, deep-dive.

​
SDK

  • Linguagens: golang, typescript.
  • Casos de uso: basic-setup, organization-crud, transaction-processing, authentication-setup, error-handling.

​
Complexidade

  • overview: Resumo de alto nível.
  • detailed: Guia completo.
  • deep-dive: Aprofundamento técnico com contexto.

​
Roles de usuário

  • developer: Para quem escreve código.
  • admin: Para administradores de sistema.
  • business: Para consumidores de dados e analistas.
  • explorer: Para usuários explorando a funcionalidade do Midaz.

​
Combinando ferramentas e prompts

Você pode combinar qualquer ferramenta com um prompt para criar uma experiência totalmente personalizada. Por exemplo:
  • Um desenvolvedor iniciante pode usar midaz-learn com um prompt de tutorial.
  • Um usuário técnico pode acessar midaz-docs com api-reference para revisão detalhada de endpoints.
Essas combinações liberam sessões dinâmicas, guiadas e altamente produtivas, impulsionadas pelo seu assistente.

​
Como funciona?

O Lerian MCP ensina seu assistente usando três inputs principais:

​
1. Documentação

Qualquer coisa adicionada ao llms.txt fica imediatamente disponível para seu LLM, incluindo guias de produto, exemplos e conceitos.

​
2. Ferramentas de API

O assistente aprende como chamar suas APIs, incluindo endpoints, campos obrigatórios e formatos de resposta, através de ferramentas estruturadas.

​
3. Prompts e workflows

Ele aprende como interagir: o que perguntar, quando perguntar e como validar o próximo passo. O resultado? Uma IA mais inteligente, segura e proativa.

​
Fluxo de invocação de ferramenta

Este é o fluxo principal usado na maioria das interações com o assistente. Quando você pede ao seu assistente para “criar uma organização” ou “obter detalhes do ledger”, ele segue esta sequência:
  • O LLM chama a ferramenta.
  • O MCP valida e enriquece o input.
  • O handler da ferramenta é acionado.
  • A requisição à API é enviada.
  • A resposta é retornada ao assistente em tempo real.
O diagrama a seguir mostra como uma requisição de invocação de ferramenta flui pelo servidor MCP.

​
Descoberta e registro de ferramentas

Toda vez que o servidor MCP inicia, ele registra um conjunto de ferramentas, como get-api-reference, generate-code-examples e get-architecture-overview. Essas ferramentas são automaticamente adaptadas às capacidades de cada client MCP (ex.: Claude Desktop, Cursor, ChatGPT). Isso torna fácil manter as coisas atualizadas: uma vez que uma ferramenta é registrada, seu assistente sabe como usá-la. O diagrama a seguir mostra como o Lerian MCP anuncia ferramentas para seu assistente e as torna utilizáveis dentro do client.

​
Tratamento de erros a nível de protocolo

Se algo der errado (ex.: uma chamada de ferramenta malformada, uma resposta inesperada do backend ou uma configuração faltando), o servidor MCP retorna graciosamente um erro padronizado. Em muitos casos, o assistente pode se recuperar e tentar novamente com input melhorado ou lógica de fallback. O diagrama a seguir mostra como o Lerian MCP detecta, trata e comunica erros a nível de protocolo.

​
De recursos para ferramentas

Fizemos a transição de recursos estáticos para ferramentas interativas, para que seu assistente possa explorar, gerar, testar e resolver problemas com interatividade real.
AspectoRecursosFerramentas de documentação
Suporte a clientsLimitadoSuporte completo em todos os clients MCP.
FuncionalidadeConteúdo estáticoContextual, interativo, dinâmico.
ExemplosTexto básicoCódigo pronto para produção.
PesquisaNenhumaPesquisa fuzzy com filtros.
TroubleshootingNão disponívelFerramentas de diagnóstico e dicas de prevenção.
InteratividadeSomente leituraTours guiados, demos e geração de código.

​
O que as ferramentas possibilitam

As ferramentas do Lerian MCP são projetadas para ajudar seu assistente a ajudar você. Aqui está o que elas cobrem:
  • Referência de API: Obtenha documentação detalhada de endpoints com payloads, métodos e exemplos.
  • Tutoriais e guias: Aprenda sobre configuração, onboarding e melhores práticas.
  • Arquitetura: Explore como os componentes se conectam, incluindo diagramas opcionais.
  • Documentação de SDK: Acesse documentação dos SDKs Go e TypeScript, com exemplos de código.
  • Geração de código: Gere snippets funcionais para tarefas como criação de contas ou transferência de fundos.
  • Padrões de workflow: Entenda fluxos comuns como onboarding, relatórios e rastreamento de assets.
  • Troubleshooting: Obtenha ajuda em tempo real para resolver problemas de integração.
  • Pesquisa e navegação: Localize rapidamente tópicos relevantes com filtros avançados.
  • Ferramentas de exploração: Execute health checks, faça tours guiados e explore capacidades.
Quer a referência completa com todas as ferramentas e parâmetros suportados? Confira a lista completa no GitHub.

​
Primeiros passos

O Lerian MCP funciona localmente e se integra com múltiplos assistentes de IA. Tudo que você precisa é do Node.js instalado e de uma das ferramentas suportadas abaixo. Antes de configurá-lo, verifique quais ferramentas estão disponíveis para seu sistema operacional:
FerramentaLinuxmacOSWindowsNotas
ChatGPT Desktop Não oficial Sim SimBuilds para Linux disponíveis via Flatpak e AppImage (mantidos pela comunidade).
Claude Desktop Não Sim SimNão suportado no Linux.
Claude Code (CLI) Sim Sim SimBaseado em terminal, funciona em qualquer lugar com Node.js.
Cursor IDE Sim Sim SimBaseado em Electron, suporta oficialmente todas as plataformas.
Windsurf IDE Sim Sim SimSuporte Linux disponível, embora ligeiramente limitado.
Continue (VS Code) Sim Sim SimExtensão do VS Code, totalmente multiplataforma.
Para usuários Linux, recomendamos usar Claude Code, Cursor, Windsurf ou Continue para a melhor experiência.
Agora, escolha seu assistente e siga as instruções abaixo para conectar o Lerian MCP.

​
ChatGPT Desktop

1

Abra seu arquivo de configuração MCP

  • ~/Library/Application Support/ChatGPT/mcp.json (macOS).
  • %APPDATA%\ChatGPT\mcp.json (Windows).
2

Adicione o seguinte código

{
  "mcpServers": {
    "lerian": {
      "command": "npx",
      "args": ["@lerianstudio/lerian-mcp-server@latest"]
    }
  }
}
3
Reinicie o aplicativo.

​
Claude Desktop

1

Abra o arquivo claude_desktop_config.json

  • ~/Library/Application Support/Claude/claude_desktop_config.json (macOS).
  • %APPDATA%\Claude\claude_desktop_config.json (Windows).
2

Adicione o seguinte código

{
  "mcpServers": {
    "lerian": {
      "command": "npx",
      "args": ["@lerianstudio/lerian-mcp-server@latest"]
    }
  }
}
3
Reinicie o aplicativo.

​
Compatibilidade retroativa

O nome antigo do pacote (@lerianstudio/midaz-mcp-server@latest) ainda funciona, mas está descontinuado. Por favor, migre para @lerianstudio/lerian-mcp-server. 
{
  "mcpServers": {
    "midaz": {
      "command": "npx",
      "args": ["@lerianstudio/midaz-mcp-server@latest"]
    }
  }
}

​
Claude Code

Se você está usando o Claude Code via linha de comando, use os seguintes comandos:
  • Para uma configuração única, use:
npx —yes @lerianstudio/lerian-mcp-server
  • Para adicionar ao Claude Code, use:
claude mcp add —user lerian "npx —yes @lerianstudio/lerian-mcp-server"

​
Migração do pacote antigo

Se você habilitou o MCP usando o pacote antigo @lerianstudio/midaz-mcp-server, siga estes passos:
1

Remova o pacote antigo

npm uninstall -g @lerianstudio/midaz-mcp-server
2

Instale o novo pacote

npm install -g @lerianstudio/lerian-mcp-server
3

Atualize o Claude Code

npm install -g @lerianstudio/lerian-mcp-server
4

Atualize o Claude Code

claude mcp remove midaz\
claude mcp add lerian "lerian-mcp-server"

​
Cursor IDE

1
Vá para File > Preferences > Cursor Settings > MCP.
2
Clique no botão +Add new global MCP Server.
3
Adicione o seguinte código:
{
  "mcp.servers": {
    "lerian": {
      "command": "npm",
      "args": ["exec", "@lerianstudio/lerian-mcp-server@latest"]
    }
  }
}
4
Reinicie o aplicativo.

​
Windsurf IDE

1
Vá para File> Preferences > Windsurf Settings.
2
Clique no botão Manage plugins na seção Cascade.
3
Clique em View raw config.
4
Adicione o seguinte código:
{
  "mcpServers": {
    "lerian": {
      "command": "npm",
      "args": ["exec", "@lerianstudio/lerian-mcp-server@latest"]
    }
  }
}
5
Salve o arquivo.
6
Clique em Refresh na aba Manage plugins.
No Windsurf IDE, você deve usar o painel Cascade para perguntar sobre o Midaz.

​
Continue (VS Code)

No VS Code, instale a extensão Continue e adicione o código do Lerian MCP ao arquivo config.yaml. Você pode encontrar o arquivo nos seguintes locais:
  • ~/.continue/config.yaml (MacOS / Linux).
  • %USERPROFILE%.continue\config.yaml (Windows).
Você também pode abrir o arquivo via VS Code:
1
No VS Code, abra o painel Continue a partir da barra de atividades (ou pressione cmd/ctrl + L).
2
Clique no seletor Assistant acima do campo principal de chat.
3
No dropdown, selecione o ícone de engrenagem ao lado da opção “Local Assistant”.
4
Ele abrirá o config.yaml local.
5
Adicione o seguinte código e salve o arquivo:
mcpServers:
  - name: Lerian
    command: npx
    args:
      - '@lerianstudio/lerian-mcp-server@latest'
6
Feche e reabra o VS Code.
7
Abra o painel Continue a partir da barra de atividades.

​
Precisa de ajuda?

​
Algo não está funcionando?

Vamos verificar o básico primeiro:
1
Reinicie seu assistente de IA depois de salvar a configuração.
2

Verifique o caminho do arquivo

Você está editando o arquivo de configuração correto?
3

Faça um teste rápido

Pergunte ao seu assistente: “Você consegue acessar a documentação da Lerian?”

​
Ainda com problemas?

  • Usando Claude Desktop? - Certifique-se de que o MCP está habilitado na sua versão.
  • Usando outro aplicativo de IA? - Confirme que o Node.js está instalado na sua máquina.
  • Precisa de ajuda? - Abra um ticket no GitHub Issues.

​
Migrando do Midaz MCP?

Sem problemas, ambos os pacotes funcionam exatamente da mesma forma:
  • Você pode usar tanto @lerianstudio/midaz-mcp-server quanto @lerianstudio/lerian-mcp-server.
  • Ambas as variáveis de ambiente MIDAZ_* e LERIAN_* são suportadas.
  • Arquivos de configuração funcionam tanto da pasta .midaz/ quanto da .lerian/.
  • Os comandos CLI midaz-mcp-server e lerian-mcp-server são intercambiáveis.
Como migrar:
1
Aponte sua configuração para @lerianstudio/lerian-mcp-server.
2
Reinicie seu assistente de IA.
3
(Opcional) Atualize suas variáveis de ambiente de MIDAZ_* para LERIAN_*.
4
(Opcional) Mova seus arquivos de configuração para .lerian/.

​
Pronto para começar?

Seu assistente está. Basta conectar a configuração, reiniciar seu aplicativo e começar a construir, aprender e entregar mais rápido.