> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Lerian MCP

> Conecta asistentes de IA como Claude, Cursor o Windsurf al ecosistema Midaz con acceso seguro y en tiempo real a documentación, APIs y servicios locales.

Lerian MCP conecta tu asistente de IA directamente al ecosistema de Midaz. Ya sea que estés usando ChatGPT, Claude, Cursor, Windsurf u otro cliente compatible, este servidor le da a tu Modelo de Lenguaje Grande (LLM) acceso seguro y en tiempo real a la documentación, APIs e incluso servicios locales de Midaz.

Es como darle a tu asistente conocimiento interno, para que pueda leer los documentos, generar código, ejecutar acciones y ayudarte a moverte más rápido.

## ¿Qué es MCP?

***

MCP significa Model Context Protocol (Protocolo de Contexto de Modelo). Piénsalo como Bluetooth para LLMs: es cómo tu IA aprende qué herramientas puede usar, cómo funciona tu sistema y qué preguntas hacer para hacer el trabajo.

**Lerian MCP** enseña a tu asistente a:

* Entender documentación, arquitectura y SDKs.
* Usar APIs a través de herramientas integradas.
* Preguntarse inteligentemente con preguntas de seguimiento.

Una vez conectado, tu asistente se vuelve consciente del contexto y capaz de actuar.

## ¿Por qué usar Lerian MCP?

***

**Lerian MCP** transforma tu asistente de IA en un compañero de desarrollo productivo. Te ayuda a:

* Buscar documentación de Midaz con lenguaje natural.
* Llamar APIs locales de Midaz usando herramientas (no solo texto estático).
* Entender la arquitectura, endpoints y SDKs de Midaz.
* Generar código, solucionar problemas y automatizar la configuración.
* Mantener todo local y explícitamente con permisos.

Ya sea que estés construyendo nuevas integraciones o soportando sistemas de producción, este plugin proporciona a tu LLM el contexto necesario, de forma segura e instantánea.

## Construido para la seguridad

***

La seguridad está integrada en cada paso. **Lerian MCP**:

* Se ejecuta completamente en **tu máquina**.
* Tiene acceso **de solo lectura** por defecto.
* Requiere aprobación explícita del usuario antes de escribir datos.
* No se necesitan claves API para la configuración local.
* Es de código abierto y auditable.

Tus datos permanecen donde pertenecen, bajo tu control.

## ¿Qué puede hacer tu asistente?

***

Una vez conectado, tu asistente puede interactuar con tu entorno Midaz como si ya hubiera leído la documentación.

Puede:

* Explicar cómo funcionan los conceptos de Midaz.
* Generar código para tareas del mundo real (ej., crear una organización).
* Buscar y resumir endpoints de API.
* Ayudar a depurar problemas de integración.
* Explorar la arquitectura y SDKs disponibles.
* Ejecutar herramientas preconfiguradas para llamar a tus servicios API locales.

### Ejemplos de lo que puedes preguntar

* "¿Cómo creo una transacción en Midaz?"
* "Muéstrame el código Go para incorporar una organización."
* "¿Cuál es la diferencia entre las APIs de onboarding y transaction?"
* "Ayúdame a solucionar este error 400."
* "Lista todos los tipos de cuenta de Midaz."

Es como hablar con un compañero de equipo que siempre tiene la respuesta y el ejemplo correcto listo para usar.

## Herramientas y prompts disponibles

***

**Lerian MCP** proporciona a tu asistente una caja de herramientas completa para explorar documentación, interactuar con APIs y aprender a través de orientación práctica. Todo se ejecuta localmente, de forma segura y consciente del contexto.

### Acceso completo a documentación (`midaz-docs`)

### Operaciones disponibles

* `getting-started`: Introducción a Midaz.
* `api-reference`: Documentación detallada de API.
* `search-endpoints`: Buscar por endpoint o función.
* `best-practices`: Mejores prácticas de seguridad, rendimiento y modelado.
* `architecture`: Resumen de la arquitectura del sistema.
* `sdk-docs`: Documentación oficial de SDK.
* `code-examples`: Generación de ejemplos de código.
* `workflows`: Patrones de flujo de trabajo comunes.
* `troubleshooting`: Guías de resolución de problemas y diagnóstico.
* `search`: Búsqueda general de documentación.
* `sitemap`: Estructura completa de documentación.
* `read`: Acceso directo a una página específica.
* `browse`: Navegación guiada a través de los documentos.

### Herramientas de aprendizaje guiado (`midaz-learn`)

### Tipos de contenido disponibles

* `path`: Rutas de aprendizaje personalizadas.
* `tutorial`: Tutoriales paso a paso.
* `concept`: Explicaciones profundas de conceptos.
* `search`: Búsqueda rápida a través de materiales de aprendizaje.

### Operaciones de dominio

#### Organizaciones

* `list-organizations`: Listar todas las organizaciones.
* `get-organization`: Obtener detalles de una organización específica.

#### Ledgers

* `list-ledgers`: Listar todos los *Ledgers* en una organización.
* `get-ledger`: Obtener detalles de un *Ledger* específico.

#### Cuentas

* `list-accounts`: Listar todas las cuentas bajo un *Ledger*.
* `get-account`: Obtener detalles de cuenta.
* `get-balance`: Verificar el saldo de la cuenta.

#### Transacciones

* `list-transactions`: Listar todas las transacciones.
* `get-transaction`: Obtener detalles de una transacción.

#### SDK

* `generate-sdk-code`: Generar código usando SDKs oficiales.
* `compare-sdk-features`: Comparar características entre SDKs.
* `find-sdk-examples`: Buscar ejemplos de código específicos.

### Prompts disponibles

Tu asistente también entiende una amplia gama de prompts integrados que adaptan el contenido al nivel de experiencia, tiempo disponible o rol del usuario.

#### Documentación

* **Formato**: `detailed`, `summary`, `examples-only`.
* **Categorías**: `api`, `guides`, `examples`, `models`, `components`.

#### Aprendizaje

* **Nivel de experiencia**: `beginner`, `intermediate`, `advanced`.
* **Modo de aprendizaje**: `explain`, `show-me`, `guide-me`, `deep-dive`.
* **Tiempo disponible**: `5min`, `15min`, `30min`, `1hour`, `deep-dive`.

#### SDK

* **Lenguajes**: `golang`, `typescript`.
* **Casos de uso**: `basic-setup`, `organization-crud`, `transaction-processing`, `authentication-setup`, `error-handling`.

#### Complejidad

* `overview`: Resumen de alto nivel.
* `detailed`: Tutorial completo.
* `deep-dive`: Inmersión técnica profunda con contexto.

### Roles de usuario

* `developer`: Para quienes escriben código.
* `admin`: Para administradores de sistemas.
* `business`: Para consumidores de datos y analistas.
* `explorer`: Para usuarios explorando la funcionalidad de Midaz.

### Combinando herramientas y prompts

Puedes combinar cualquier herramienta con un prompt para crear una experiencia completamente personalizada. Por ejemplo:

* Un desarrollador principiante podría usar `midaz-learn` con un prompt `tutorial`.
* Un usuario técnico podría acceder a `midaz-docs` con `api-reference` para una revisión detallada de endpoints.

Estas combinaciones desbloquean sesiones dinámicas, guiadas y altamente productivas, impulsadas por tu asistente.

## ¿Cómo funciona?

***

**Lerian MCP** enseña a tu asistente usando tres entradas clave:

#### 1. Documentación

Cualquier cosa agregada a llms.txt está inmediatamente disponible para tu LLM, incluyendo guías de producto, ejemplos y conceptos.

#### 2. Herramientas API

El asistente aprende cómo llamar a tus APIs, incluyendo endpoints, campos requeridos y formatos de respuesta, a través de herramientas estructuradas.

#### 3. Prompts y flujos de trabajo

Aprende cómo interactuar: qué preguntar, cuándo preguntar y cómo validar el siguiente paso. ¿El resultado? Una IA más inteligente, segura y proactiva.

### Flujo de invocación de herramientas

Este es el flujo principal utilizado en la mayoría de las interacciones del asistente. Cuando le pides a tu asistente "crear una organización" u "obtener detalles del *Ledger*", sigue esta secuencia:

* El LLM llama a la herramienta.
* MCP valida y enriquece la entrada.
* Se activa el manejador de herramientas.
* Se envía la solicitud API.
* La respuesta se devuelve al asistente en tiempo real.

El siguiente diagrama muestra cómo fluye una solicitud de invocación de herramienta a través del servidor MCP.

<Frame>
  <img src="https://mintcdn.com/lerian-49cb71fc/ZrZBZTM4DWnrahSd/images/es/d2/mcp-tools-flow.svg?fit=max&auto=format&n=ZrZBZTM4DWnrahSd&q=85&s=9b8bffb5fd94e31c3bf6b2139ce8a21a" alt="Cómo una invocación de herramienta fluye por el servidor MCP de Lerian, desde la llamada del asistente hasta la respuesta, pasando por la validación de la entrada y la solicitud a la API" width="1779" height="2591" data-path="images/es/d2/mcp-tools-flow.svg" />
</Frame>

### Descubrimiento y registro de herramientas

Cada vez que el servidor MCP se inicia, registra un conjunto de herramientas, como `get-api-reference`, `generate-code-examples` y `get-architecture-overview`. Estas herramientas se adaptan automáticamente a las capacidades de cada cliente MCP (ej., Claude Desktop, Cursor, ChatGPT).

Esto facilita mantener las cosas actualizadas: una vez que una herramienta está registrada, tu asistente sabe cómo usarla.

El siguiente diagrama muestra cómo Lerian MCP anuncia herramientas a tu asistente y las hace utilizables dentro del cliente.

<Frame>
  <img src="https://mintcdn.com/lerian-49cb71fc/ZrZBZTM4DWnrahSd/images/es/d2/mcp-tools-assistant.svg?fit=max&auto=format&n=ZrZBZTM4DWnrahSd&q=85&s=d0b4f292f2ccb1824079cbd02b123c26" alt="Cómo el servidor MCP de Lerian registra sus herramientas al iniciarse y las anuncia al asistente para que se puedan usar dentro del cliente" width="1575" height="2373" data-path="images/es/d2/mcp-tools-assistant.svg" />
</Frame>

### Manejo de errores a nivel de protocolo

Si algo sale mal (ej., una llamada de herramienta mal formada, una respuesta inesperada del backend o una configuración faltante), el servidor MCP devuelve graciosamente un error estandarizado. En muchos casos, el asistente puede recuperarse y reintentar con entrada mejorada o lógica de respaldo.

El siguiente diagrama muestra cómo Lerian MCP detecta, maneja y comunica errores a nivel de protocolo.

<Frame>
  <img src="https://mintcdn.com/lerian-49cb71fc/ZrZBZTM4DWnrahSd/images/es/d2/mcp-protocol-errors.svg?fit=max&auto=format&n=ZrZBZTM4DWnrahSd&q=85&s=d696fdd89a7c6cfc628ddfb7cbabc4ab" alt="Cómo el servidor MCP de Lerian detecta un error a nivel de protocolo, devuelve un error estandarizado y permite que el asistente se recupere y reintente" width="1162" height="1927" data-path="images/es/d2/mcp-protocol-errors.svg" />
</Frame>

## De recursos a herramientas

***

Hemos hecho la transición de recursos estáticos a herramientas interactivas, para que tu asistente pueda explorar, generar, probar y solucionar problemas con interactividad real.

| Aspecto               | Recursos           | Herramientas de documentación                         |
| :-------------------- | :----------------- | :---------------------------------------------------- |
| Soporte de cliente    | Limitado           | Soporte completo en todos los clientes MCP.           |
| Funcionalidad         | Contenido estático | Contextual, interactivo, dinámico.                    |
| Ejemplos              | Texto básico       | Código listo para producción.                         |
| Búsqueda              | Ninguna            | Búsqueda difusa con filtros.                          |
| Solución de problemas | No disponible      | Herramientas de diagnóstico y consejos de prevención. |
| Interactividad        | Solo lectura       | Tours guiados, demos y generación de código.          |

### Lo que las herramientas desbloquean

Las herramientas de **Lerian MCP** están diseñadas para ayudar a tu asistente a ayudarte. Esto es lo que cubren:

* **Referencia de API**: Obtén documentación detallada de endpoints con payloads, métodos y ejemplos.
* **Tutoriales y guías**: Aprende configuración, incorporación y mejores prácticas.
* **Arquitectura**: Explora cómo se conectan los componentes, incluidos diagramas opcionales.
* **Documentación de SDK**: Accede a documentación de SDK de Go y TypeScript, con ejemplos de código.
* **Generación de código**: Genera fragmentos funcionales para tareas como creación de cuentas o transferencias de fondos.
* **Patrones de flujo de trabajo**: Comprende flujos comunes como incorporación, informes y seguimiento de activos.
* **Solución de problemas**: Obtén ayuda en tiempo real para resolver problemas de integración.
* **Búsqueda y navegación**: Localiza rápidamente temas relevantes con filtros avanzados.
* **Herramientas de exploración**: Ejecuta verificaciones de salud, prueba tours guiados y explora capacidades.

<Tip>
  ¿Quieres la referencia completa con todas las herramientas y parámetros admitidos? Consulta la lista completa en [GitHub](https://github.com/LerianStudio/midaz-mcp-server/blob/main/diagrams/README.md).
</Tip>

## Comenzando

***

**Lerian MCP** funciona localmente y se integra con múltiples asistentes de IA. Todo lo que necesitas es [Node.js](https://nodejs.org/en/download) instalado y una de las herramientas compatibles a continuación.

Antes de configurarlo, verifica qué herramientas están disponibles para tu sistema operativo:

| Herramienta            | Linux                                                           | macOS                                         | Windows                                       | Notas                                                                                   |
| :--------------------- | :-------------------------------------------------------------- | :-------------------------------------------- | :-------------------------------------------- | :-------------------------------------------------------------------------------------- |
| **ChatGPT Desktop**    | <Icon icon="triangle-exclamation" color="#f1ba5c" /> No oficial | <Icon icon="square-check" color="green" /> Sí | <Icon icon="square-check" color="green" /> Sí | Compilaciones de Linux disponibles vía Flatpak y AppImage (mantenido por la comunidad). |
| **Claude Desktop**     | <Icon icon="xmark" color="red" /> No                            | <Icon icon="square-check" color="green" /> Sí | <Icon icon="square-check" color="green" /> Sí | No compatible con Linux.                                                                |
| **Claude Code (CLI)**  | <Icon icon="square-check" color="green" /> Sí                   | <Icon icon="square-check" color="green" /> Sí | <Icon icon="square-check" color="green" /> Sí | Basado en terminal, funciona en cualquier lugar con Node.js.                            |
| **Cursor IDE**         | <Icon icon="square-check" color="green" /> Sí                   | <Icon icon="square-check" color="green" /> Sí | <Icon icon="square-check" color="green" /> Sí | Basado en Electron, soporta oficialmente todas las plataformas.                         |
| **Windsurf IDE**       | <Icon icon="square-check" color="green" /> Sí                   | <Icon icon="square-check" color="green" /> Sí | <Icon icon="square-check" color="green" /> Sí | Soporte de Linux disponible, aunque ligeramente limitado.                               |
| **Continue (VS Code)** | <Icon icon="square-check" color="green" /> Sí                   | <Icon icon="square-check" color="green" /> Sí | <Icon icon="square-check" color="green" /> Sí | Extensión de VS Code, completamente multiplataforma.                                    |

<Tip>
  Para usuarios de Linux, recomendamos usar **Claude Code**, **Cursor**, **Windsurf** o **Continue** para la mejor experiencia.
</Tip>

Ahora, elige tu asistente y sigue las instrucciones a continuación para conectar Lerian MCP.

### ChatGPT Desktop

<Steps>
  <Step title="Abre tu archivo de configuración MCP">
    * `~/Library/Application Support/ChatGPT/mcp.json` (macOS).
    * `%APPDATA%\ChatGPT\mcp.json` (Windows).
  </Step>

  <Step title="Agrega el siguiente código">
    <CodeGroup>
      ```bash Shell theme={null}
      {
        "mcpServers": {
          "lerian": {
            "command": "npx",
            "args": ["@lerianstudio/lerian-mcp-server@latest"]
          }
        }
      }
      ```
    </CodeGroup>
  </Step>

  <Step>
    Reinicia la aplicación.
  </Step>
</Steps>

### Claude Desktop

<Steps>
  <Step title="Abre el archivo claude_desktop_config.json">
    * `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS).
    * `%APPDATA%\Claude\claude_desktop_config.json` (Windows).
  </Step>

  <Step title="Agrega el siguiente código">
    <CodeGroup>
      ```bash Shell theme={null}
      {
        "mcpServers": {
          "lerian": {
            "command": "npx",
            "args": ["@lerianstudio/lerian-mcp-server@latest"]
          }
        }
      }
      ```
    </CodeGroup>
  </Step>

  <Step>
    Reinicia la aplicación.
  </Step>
</Steps>

#### Compatibilidad hacia atrás

El nombre antiguo del paquete (`@lerianstudio/midaz-mcp-server@latest`) todavía funciona, pero está obsoleto. Por favor migra a `@lerianstudio/lerian-mcp-server`.

<CodeGroup>
  ```bash Shell theme={null}
  {
    "mcpServers": {
      "midaz": {
        "command": "npx",
        "args": ["@lerianstudio/midaz-mcp-server@latest"]
      }
    }
  }
  ```
</CodeGroup>

### Claude Code

Si estás usando Claude Code vía línea de comandos, usa los siguientes comandos:

* Para una configuración única, usa:

<CodeGroup>
  ```bash Shell theme={null}
  npx —yes @lerianstudio/lerian-mcp-server
  ```
</CodeGroup>

* Para agregar a Claude Code, usa:

<CodeGroup>
  ```bash Shell theme={null}
  claude mcp add —user lerian "npx —yes @lerianstudio/lerian-mcp-server"
  ```
</CodeGroup>

#### Migración desde el paquete antiguo

Si habilitaste el MCP usando el paquete antiguo `@lerianstudio/midaz-mcp-server`, sigue estos pasos:

<Steps>
  <Step title="Eliminar paquete antiguo">
    <CodeGroup>
      ```bash Shell theme={null}
      npm uninstall -g @lerianstudio/midaz-mcp-server
      ```
    </CodeGroup>
  </Step>

  <Step title="Instalar nuevo paquete">
    <CodeGroup>
      ```bash Shell theme={null}
      npm install -g @lerianstudio/lerian-mcp-server
      ```
    </CodeGroup>
  </Step>

  <Step title="Actualizar Claude Code">
    <CodeGroup>
      ```bash Shell theme={null}
      npm install -g @lerianstudio/lerian-mcp-server
      ```
    </CodeGroup>
  </Step>

  <Step title="Actualizar Claude Code">
    <CodeGroup>
      ```bash Shell theme={null}
      claude mcp remove midaz\
      claude mcp add lerian "lerian-mcp-server"
      ```
    </CodeGroup>
  </Step>
</Steps>

### Cursor IDE

<Steps>
  <Step>
    Ve a **File** > **Preferences** > **Cursor Settings** > **MCP**.
  </Step>

  <Step>
    Haz clic en el botón **+Add new global MCP Server**.
  </Step>

  <Step>
    Agrega el siguiente código:

    <CodeGroup>
      ```bash Shell theme={null}
      {
        "mcp.servers": {
          "lerian": {
            "command": "npm",
            "args": ["exec", "@lerianstudio/lerian-mcp-server@latest"]
          }
        }
      }
      ```
    </CodeGroup>
  </Step>

  <Step>
    Reinicia la aplicación.
  </Step>
</Steps>

### Windsurf IDE

<Steps>
  <Step>
    Ve a **File**> **Preferences** > **Windsurf Settings**.
  </Step>

  <Step>
    Haz clic en el botón **Manage plugins** en la sección *Cascade*.
  </Step>

  <Step>
    Haz clic en **View raw config**.
  </Step>

  <Step>
    Agrega el siguiente código:

    <CodeGroup>
      ```bash Shell theme={null}
      {
        "mcpServers": {
          "lerian": {
            "command": "npm",
            "args": ["exec", "@lerianstudio/lerian-mcp-server@latest"]
          }
        }
      }
      ```
    </CodeGroup>
  </Step>

  <Step>
    Guarda el archivo.
  </Step>

  <Step>
    Haz clic en **Refresh** en la pestaña **Manage plugins**.
  </Step>
</Steps>

<Warning>
  En Windsurf IDE, debes usar el panel Cascade para preguntar sobre Midaz.
</Warning>

### Continue (VS Code)

En VS Code, instala la extensión **Continue** y agrega el código Lerian MCP al archivo `config.yaml`.

Puedes encontrar el archivo en las siguientes ubicaciones:

* `~/.continue/config.yaml` (MacOS / Linux).
* `%USERPROFILE%.continue\config.yaml `(Windows).

También puedes abrir el archivo vía VS Code:

<Steps>
  <Step>
    En VS Code, abre el panel **Continue** desde la barra de actividad (o presiona `cmd/ctrl + L`).
  </Step>

  <Step>
    Haz clic en el selector **Assistant** encima de la entrada de chat principal.
  </Step>

  <Step>
    Desde ese menú desplegable, selecciona el ícono de engranaje junto a la opción "Local Assistant".
  </Step>

  <Step>
    Se abrirá el `config.yaml` local.
  </Step>

  <Step>
    Agrega el siguiente código y guarda el archivo:

    <CodeGroup>
      ```bash JSON theme={null}
      mcpServers:
        - name: Lerian
          command: npx
          args:
            - '@lerianstudio/lerian-mcp-server@latest'
      ```
    </CodeGroup>
  </Step>

  <Step>
    Cierra y vuelve a abrir VS Code.
  </Step>

  <Step>
    Abre el panel **Continue** desde la *Barra de actividad*.
  </Step>
</Steps>

## ¿Necesitas ayuda?

***

#### ¿Algo no está funcionando?

Primero saquemos lo básico del camino:

<Steps>
  <Step>
    **Reinicia tu asistente de IA** después de guardar la configuración.
  </Step>

  <Step title="Verifica dos veces la ruta del archivo">
    ¿Estás editando el archivo de configuración correcto?
  </Step>

  <Step title="Ejecuta una prueba rápida">
    Pregunta a tu asistente, "¿Puedes acceder a la documentación de Lerian?"
  </Step>
</Steps>

#### ¿Aún atascado?

* **¿Usando Claude Desktop?** - Asegúrate de que MCP esté habilitado en tu versión.
* **¿Usando cualquier otra aplicación de IA?** - Confirma que Node.js esté instalado en tu máquina.
* **¿Necesitas ayuda?** - Abre un ticket en [GitHub Issues](https://github.com/lerianstudio/lerian-mcp-server/issues).

#### ¿Migrando desde Midaz MCP?

No te preocupes, ambos paquetes funcionan exactamente igual:

* Puedes usar `@lerianstudio/midaz-mcp-server` o `@lerianstudio/lerian-mcp-server`.
* Ambas variables de entorno `MIDAZ_*` y `LERIAN_*` son compatibles.
* Los archivos de configuración funcionan desde las carpetas `.midaz/` o `.lerian/`.
* Los comandos CLI `midaz-mcp-server` y `lerian-mcp-server` son intercambiables.

**Cómo cambiar:**

<Steps>
  <Step>
    Apunta tu configuración a `@lerianstudio/lerian-mcp-server`.
  </Step>

  <Step>
    Reinicia tu asistente de IA.
  </Step>

  <Step>
    (Opcional) Actualiza tus variables de entorno de `MIDAZ_*` a `LERIAN_*`.
  </Step>

  <Step>
    (Opcional) Mueve tus archivos de configuración a `.lerian/`.
  </Step>
</Steps>

## ¿Listo para comenzar?

***

Tu asistente lo está. Solo conecta la configuración, reinicia tu aplicación y comienza a construir, aprender y enviar más rápido.
