playbooks

home / mcp / ix api mcp server

Ix API MCP Server

MCP Server generated by mcp.ag2.ai

Installation
Add the following to your MCP client configuration file.

Configuration

View docs
{
  "mcpServers": {
    "ag2-mcp-servers-ix-api": {
      "command": "python",
      "args": [
        "mcp_server/main.py",
        "stdio"
      ],
      "env": {
        "CONFIG": "{\"...\":\"...\"}",
        "SECURITY": "API keys and other security parameters",
        "CONFIG_PATH": "mcp_server/mcp_config.json"
      }
    }
  }
}

You run an MCP server that exposes the OpenAPI-based model context protocol for ix-api, enabling clients to interact with the API through a stable MCP interface. This server can be started locally in stdio mode and supports environment-based configuration for flexible deployment.

How to use

Start the MCP server in stdio mode to run locally and interact with your client applications. Use the provided command to begin serving, then connect your MCP client to the standard input/output stream. Configure your client to target the local runtime and pass your MCP configuration as needed. You can control security and configuration through environment variables and an external JSON configuration if required.

How to install

Prerequisites: Python 3.9 or newer, and the ability to run Python scripts with access to a shell.

Step by step commands to set up and run the MCP server locally:

# Step 1: Install dependencies (in a development or virtual environment)
pip install -e ".[dev]"

# If you are using the uv runner instead of a dev container, you can install editable dev dependencies with uvx
# (adjust command to your environment if needed)
uvx pip install --editable ".[dev]"

# Step 2: Run the MCP server in stdio mode
python mcp_server/main.py stdio

Configuration and security

Configure how the server loads its settings using environment variables. The following variables are supported:

CONFIG_PATH: Path to a JSON configuration file (for example, mcp_server/mcp_config.json).

CONFIG: A JSON string containing the server configuration.

SECURITY: Environment variables that define security parameters such as API keys.

Available tools

start_stdio_server

Launch the MCP server in stdio mode using python mcp_server/main.py stdio.

run_tests

Run the test suite with pytest and generate a coverage report.