Planning Data

MCP Server generated by mcp.ag2.ai

python

0

GitHub Stars

python

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "alizoli-planningdatagovuk-api": {
      "command": "python",
      "args": [
        "mcp_server/main.py",
        "stdio"
      ],
      "env": {
        "CONFIG": "{...} - JSON string configuration",
        "SECURITY": "YOUR_API_KEYS_OR_KEYS",
        "CONFIG_PATH": "path/to/mcp_config.json"
      }
    }
  }
}

You run an MCP server that connects to a defined OpenAPI data source and exposes a structured protocol for clients to interact with planning data. This server enables you to query, explore, and manage data through a consistent MCP interface, making integration with your applications straightforward and scalable.

How to use

Start the server in stdio mode to interact with it directly from your development environment. Once the server is running, you can connect your MCP client to it and begin sending requests to explore the planning data exposed by the MCP endpoint.

How to install

Prerequisites are Python 3.9 or newer and the Python package manager tools. You will also use uv to run commands in a lightweight, asynchronous environment when needed.

# Step 1: Install Python dependencies (from a suitable environment)
pip install -e ".[dev]"

# If you prefer using uv to run commands directly, you can install the editable package with uv
uv pip install --editable ".[dev]"

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

Additional sections

Configuration and runtime are controlled primarily through environment variables. The following variables are commonly used to configure the MCP server:

CONFIG_PATH: Path to a JSON configuration file (e.g., mcp_server/mcp_config.json).
CONFIG: A JSON string containing the configuration.
SECURITY: Environment variables for security parameters (e.g., API keys).

Available tools

lint

Check code quality and formatting using the linting tool to enforce style and catch potential issues.

format

Automatically format code according to project style guidelines.

static-analysis

Run static analysis tools (type checks, security checks) to ensure code safety and correctness.

test

Execute unit tests and generate a coverage report to verify functionality.