Leanix MCP Integration

🚀 LeanIX MCP Integration

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

🚀 Quick Start

This integration provides five MCP tools for LeanIX operations. Before you start, make sure you have the following prerequisites:

Prerequisites

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

Steps

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
   

✨ Features

This integration offers five MCP tools for LeanIX operations:

1. Fact Sheet Overview: Get the number and statistical information of fact sheets in the workspace.
2. Search: Find fact sheets by name.
3. Subscription Management: View subscribers of a specific fact sheet.
4. Create Fact Sheet: Add a new fact sheet to the workspace.
5. Update Fact Sheet: Modify information of an existing fact sheet.

📦 Installation

The installation steps are included in the Quick Start section.

📚 Documentation

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 variant definitions
├── datamodel           # Data models and type definitions
├── .env                # Environment configuration
└── src/
    ├── config/
    │   └── config.js         # Load and validate LeanIX credentials from environment variables
    ├── graphql/
    │   └── queries/         # GraphQL queries and variants
    │       ├── factSheetQueries.js     # Queries for fact sheet operations
    │       └── workspaceQueries.js     # Queries for workspace-level operations
    ├── tools/
    │   └── workspaceTools.js # Define and register five MCP tools
    ├── types/
    │   └── schemas.js       # Zod schemas for tool parameter validation
    └── utils/
        └── responseHandler.js # Format responses in an MCP-compatible structure

Frequently Asked Questions and Solutions

1. GraphQL Schema Mismatch: Always check the current LeanIX API schema as it may change over time.
2. Response Format: All MCP tool responses must follow the following format:

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

3. Error Handling: Always wrap tool implementations with withErrorHandling to ensure correct error responses.
4. Environment Variables: Make sure to correctly load and validate environment variables before making any API calls.

Claude Desktop Configuration

To use this MCP server with Claude Desktop, add the server configuration to Claude's configuration file. The configuration file is usually 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 of the server.js file. This instructs Claude Desktop to:

1. Start this MCP server when needed.
2. Perform LeanIX operations through it.
3. Run it using Node.js.

Testing Your Integration

1. Start the server:

   node server.js
   

2. Open a browser and visit http://localhost:3000.

Debugging Tips

• Ensure all environment variables are correctly set.
• Check the console output for any error or warning messages.
• Use browser developer tools to inspect network requests and responses.

🔗 Resources

• LeanIX Documentation
• GraphQL Official Website
• MCP Protocol Documentation