Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Lerian MCP ServerShow me how to create a workflow in Flowker"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Lerian MCP Server
Your AI's gateway to Lerian documentation, guides, and learning resources!
This MCP server connects Claude, ChatGPT, and other AI assistants to comprehensive documentation for all 5 Lerian products (Midaz, Tracer, Flowker, Reporter, and more). Get instant help with integration, best practices, and code generationβall through natural conversation.
π Documentation-Only Mode: This server provides documentation and learning resources. It does NOT connect to Lerian backend APIs. For live API access, use Lerian SDKs in your application.
β‘ 2-Minute Setup
Step 1: Choose your AI assistant Step 2: Copy the configuration below Step 3: Restart your AI app Step 4: Ask: "What can you tell me about Lerian Midaz?"
π₯οΈ Claude Desktop
Location: ~/Library/Application Support/Claude/claude_desktop_config.json (macOS)
Location: %APPDATA%\Claude\claude_desktop_config.json (Windows)
π₯οΈ Cursor / Windsurf / Continue
Add to your MCP configuration:
π¬ ChatGPT Desktop
Same configuration in your ChatGPT Desktop MCP settings file.
β¨ What You Get
ONE powerful tool for ALL 5 Lerian products:
π¦ Supported Products
Midaz - Financial ledger system with double-entry accounting
Tracer - Observability and distributed tracing platform
Flowker - Workflow orchestration engine
Reporter - Reporting and analytics platform
All - Cross-product search and comparison
π― Operations
π Documentation (operation: "docs")
Get comprehensive documentation for any product:
π Learning (operation: "learn")
Interactive tutorials adapted to your experience level:
π» SDK Generation (operation: "sdk")
Production-ready code in 3 languages:
π Search (operation: "search")
Find anything across all products:
π Example Conversations
Getting Started
You: "What can you tell me about Lerian Midaz?" AI: Uses β Gets comprehensive Midaz documentation, explains core concepts
Learning Path
You: "I'm new to Tracer, how do I get started?" AI: Uses β Provides beginner-friendly tutorial with step-by-step guidance
Code Generation
You: "Show me Go code for creating a Midaz ledger" AI: Uses β Generates production-ready Go code with comments and best practices
Cross-Product Search
You: "How do the different Lerian products handle authentication?" AI: Uses β Searches across all products, provides comparison
π― The ONE Tool
The entire MCP server is built around a single, intelligent tool:
Why ONE tool?
π― Simple to discover and use
π Consistent experience across all products
π Easy for AI to understand
π¦ Minimal context usage
β‘ Fast and efficient
π‘ Key Features
β Zero Configuration
Auto-generates required secrets on first run
Stores in
~/.lerian/secrets.json(secure, persistent)Works immediately with
npx- no manual setup
β All Products, One Interface
Unified access to Midaz, Tracer, Flowker, Reporter
Cross-product search and comparison
Consistent documentation format
β Smart Documentation
Auto-loads from
docs.lerian.studio/llms.txtAlways up-to-date with latest docs
Rich formatting optimized for AI understanding
β Multi-Language SDK
Go (backend services)
TypeScript (type-safe web)
JavaScript (Node.js/browser)
Production-ready code with best practices
β Experience-Based Learning
Beginner-friendly tutorials
Intermediate deep-dives
Advanced patterns and architecture
Role-specific guidance (developer/admin/business)
π Safe & Secure
β No API access - Documentation only, can't execute operations
β All local - Documentation cached on your machine
β Zero vulnerabilities - Comprehensive security audit completed
β Auto-secret generation - Cryptographic keys auto-managed
β Open source - Fully auditable code
π Documentation
Quick Links
π Full Documentation
π Learning Paths
π» SDK Reference
π Troubleshooting
For Developers
π§ Makefile Commands -
make helpfor all commandsπ§ͺ Testing Guide
π Architecture
π Security
π οΈ Advanced Usage
Custom Documentation URL
Enable Logging
Logs are stored in ./logs/ directory.
π Troubleshooting
Server Not Starting?
Check Node.js version: Requires Node.js 18+
node --version # Should show v18 or higherTest manually:
npx -y @lerianstudio/lerian-mcp-serverCheck secrets:
ls -la ~/.lerian/secrets.json
Tool Not Responding?
Restart your AI assistant after changing configuration
Verify MCP is enabled in your AI assistant's settings
Check logs (if enabled):
./logs/error.log
Getting Help
π GitHub Issues
π¬ Lerian Community
π Documentation
π¦ Package Information
npm Package: @lerianstudio/lerian-mcp-server
Version: 4.0.0 (Documentation-Only Mode)
License: Apache-2.0
Repository: GitHub
Migration from v3.x
Version 4.0.0 is a major breaking change that removes all API connectivity.
What's Removed:
β All 18 financial API tools
β Backend service connectivity
β Live data queries
What You Gain:
β Focused documentation experience
β 5 products in ONE tool
β Faster, simpler, more reliable
β Zero configuration required
Need API access? Use Lerian SDKs directly in your application.
See MIGRATION-V4.md for full migration guide.
ποΈ Architecture
The Ultimate Simplification:
Tool Count: 1 (down from 23!)
Products: 5 (midaz, tracer, flowker, reporter, all)
Operations: 4 (docs, learn, sdk, search)
Languages: 3 (Go, TypeScript, JavaScript)
Data Source: docs.lerian.studio/llms.txt (auto-updated)
Layers:
Infrastructure - Config, logging, security
Transport - MCP stdio protocol
Protocol - Message handling, cursors
Client Adaptation - Response formatting
Tool - Single unified lerian tool
Business Logic - Documentation workflows
No API/Integration layer - Pure documentation MCP β
π Why This MCP?
For AI Users
π― One tool, everything - No complexity, just ask
π Always current - Auto-updates from official docs
π Learn by doing - Interactive tutorials
π» Copy-paste code - Production-ready examples
For Developers
β‘ Zero setup - Just
npxand goπ Secure by default - No credentials needed
πͺΆ Lightweight - Minimal dependencies
π§ Just works - Auto-generates secrets
For Organizations
π Single source of truth - Official Lerian documentation
π Faster onboarding - AI-assisted learning
β Best practices - Built into examples
π Safe - Read-only, can't modify data
Ready to explore Lerian with AI? Install now and ask your first question! π