What is Leanix Mcp Integration

The LeanIX MCP Integration is a Model Context Protocol server that connects LeanIX’s enterprise architecture platform with AI assistants. It exposes LeanIX’s GraphQL API as MCP tools, allowing AI assistants to query and manage fact sheets using natural language.

Use cases

Use cases include automating fact sheet management, enabling natural language queries for data retrieval, and integrating LeanIX with AI assistants for enhanced operational efficiency.

How to use

To use the LeanIX MCP Integration, clone the repository, install the dependencies using npm, and create a .env file with your LeanIX credentials. After setup, you can utilize the MCP tools to interact with LeanIX’s data.

Key features

Key features include: 1) Fact Sheet Overview for statistics, 2) Search for fact sheets by name, 3) Subscription Management for tracking subscriptions, 4) Create Fact Sheets to add new entries, and 5) Update Fact Sheets to modify existing information.

Where to use

LeanIX MCP Integration can be used in enterprise architecture management, data governance, and AI-driven analytics, particularly in organizations that utilize LeanIX for managing their architecture.

LeanIX MCP Integration

A Model Context Protocol (MCP) server that connects LeanIX to AI assistants. It exposes LeanIX’s GraphQL API as MCP tools that AI assistants can use.

Core Functionality

This integration provides five MCP tools for LeanIX operations:

1. Fact Sheet Overview: Get counts and statistics of fact sheets in your workspace
2. Search: Find fact sheets by their names
3. Subscription Management: View who is subscribed to specific fact sheets
4. Create Fact Sheets: Add new fact sheets to your workspace
5. Update Fact Sheets: Modify existing fact sheet information

Prerequisites

• Node.js (v14 or higher)
• A LeanIX workspace and API token
• Basic understanding of GraphQL and MCP

Getting Started

1. Clone this repository
2. Install dependencies:

   npm install
   

3. Create a .env file in the root directory with your LeanIX credentials:

   LEANIX_SUBDOMAIN=your-workspace-subdomain
   LEANIX_TOKEN=your-api-token
   

Project Structure

├── server.js            # Main MCP server setup and initialization
├── leanix-client.js     # LeanIX API client implementation
├── api                  # LeanIX API definitions and endpoints
├── mutation            # GraphQL mutation definitions
├── datamodel           # Data models and type definitions
├── .env                # Environment configuration
└── src/
    ├── config/
    │   └── config.js         # Loads and validates environment variables for LeanIX credentials
    ├── graphql/
    │   └── queries/         # GraphQL queries and mutations for LeanIX API
    │       ├── factSheetQueries.js     # Queries for fact sheet operations
    │       └── workspaceQueries.js     # Queries for workspace-level operations
    ├── tools/
    │   └── workspaceTools.js # Defines and registers the five MCP tools
    ├── types/
    │   └── schemas.js       # Zod schemas for validating tool parameters
    └── utils/
        └── responseHandler.js # Formats responses in MCP-compatible structure

Common Pitfalls and Solutions

1. GraphQL Schema Mismatch: Always check the current LeanIX API schema in their documentation or GraphiQL interface. The schema may change over time.

2. Response Formatting: All MCP tool responses must follow this format:

   {
     content: [{
       type: "text",
       text: "your response here"
     }]
   }
   

3. Error Handling: Always wrap your tool implementations with withErrorHandling to ensure proper error responses.

4. Environment Variables: Make sure to properly load and validate environment variables before making any API calls.

Claude Desktop Configuration

To use this MCP server with Claude Desktop, you need to add the server configuration to Claude’s config file. The config file is typically located at:

• Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

Add the following configuration:

{
  "mcpServers": {
    "myserver": {
      "command": "node",
      "args": [
        "/path/to/your/lean/server.js"
      ]
    }
  }
}

Replace /path/to/your/lean/server.js with the absolute path to your server.js file. This tells Claude Desktop to:

1. Start this MCP server when needed
2. Connect to it for LeanIX operations
3. Run it using Node.js

Testing Your Integration

1. Start the server:

   node server.js
   

2. The server will connect to your LeanIX workspace and make the tools available through MCP.

3. You can test your tools through any MCP-compatible client (like Claude).

Debugging Tips

1. Enable debug logging in your configuration file to verify environment variables are loaded correctly.

2. Use the LeanIX GraphiQL interface to test your queries before implementing them in your tools.

3. Check the server console for detailed error messages when tools fail.

Resources

• LeanIX API Documentation
• GraphQL Documentation
• Model Context Protocol Documentation

License

MIT