ee-mcp-service/README.md

Model Context Protocol Service for Evolution Engineering

# Evolution Engineering MCP Service

A Model Context Protocol (MCP) server for Evolution Engineering, allowing AI models to query and interact with Evolution Engineering AI Tools.

## Overview

This project implements an MCP Service that follows the Model Context Protocol (MCP) specification to connect AI models with Evolution Engineering MeTaX Service. The server translates and routes MCP requests to Evolution Engineering and formats the responses according to the MCP standard.

## Prerequisites

* Node.js (v16 or later)
* npm or yarn
* Evolution Engineering instance (running locally or remotely)

## Installation

1. Clone this repository:

   ```bash
   git clone https://github.com/EvolutionEngineering/ee-mcp-service
   cd ee-mcp-server
   ```
2. Install dependencies:

   ```bash
   npm install
   ```
3. Copy the example environment file and configure it:

   ```bash
   cp .env.example .env
   ```

   Edit `.env` with your configuration details.

## Configuration

Configuration is managed through environment variables in the `.env` file:
* `EE_API_KEY`: API key for authenticating MCP requests

## Usage

### Development

Start the development server with hot-reloading:

```bash
npm run dev
```

## MCP Test

To test distributed ee-mcp-server package you can run MCP inspector as:
```bash
npx @modelcontextprotocol/inspector npx ee-mcp-service
```

To test locally built ee-mcp-server package you can run MCP inspector as:
```bash
npx @modelcontextprotocol/inspector node ./dist/index.js
```


### Production

Build and start the server:

```bash
npm run build
npm start
```

## MCP Tools

* `read-me`: Ask AI to call "read-me" first , so it will understand how to navigate and use MeTaX MCP functionality
* `is-api-key-valid`: Validates EE API key and tests connection to EE MeTaX Service
* `get-instructions-and-tool-description`: Get instructions about the EE MeTaX Service, description of metadata objects and available tools to call
* `query-metadata-ontology`: Query Semantic Ontology of metadata objects
* `query-business`: Query Business Data
* `query-business-ontology`: Query Business Ontology
* `query-technology`: Query Technology Data
* `query-technology-ontology`: Query Technology Ontology
* `query-environment`: Query Environment Data
* `query-environment-ontology`: Query Environment Ontology
* `query-organization`: Query Organization Data
* `query-organization-ontology`: Query Organization Ontology
* `query-strategy-scenario`: Query Strategy Scenario Data
* `query-strategy-scenario-ontology`: Query Strategy Scenario Ontology

## MCP Configuration

To use this server with MCP clients, you can add it to your MCP configuration:

```json
{
  "defaultServer": "ee-mcp-service",
  "servers": {
    "ee-mcp-service":{
      "command": "node",
        "args": [
        "your_path\\dist\\index.js"
        ],
      "env": {
          "EE_API_KEY": "your_EE_MCP_API_KEY"
        }
    }
  }
}

Alternatively, instead of environment variable specification EE_API_KEY, you can provide "apiKey" parameter value directly from MCP client

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.