Skip to main content

STK-MCP, an MCP server allowing LLMs to interact with Ansys/AGI STK - Digital Mission Engineering Software

Project description

STK-MCP

Python Version MCP Version

STK-MCP is an MCP (Model Context Protocol) server designed to enable Large Language Models (LLMs) or other MCP clients to interact with Ansys/AGI STK (Systems Tool Kit) - the leading Digital Mission Engineering software.

This project allows controlling STK Desktop via MCP tools, leveraging the STK Python API. It utilizes FastMCP from the official MCP Python SDK. The server logic resides within the src/stk_mcp package.

Overview

The primary goal of this project is to bridge the gap between programmatic or natural language interaction (via LLMs) and the powerful simulation capabilities of STK. By exposing STK functionalities through an MCP server, users can command STK simulations using MCP clients or potentially LLM-driven applications.

The MCP server, defined in src/stk_mcp/server.py, manages STK interaction and exposes functionality, showcasing how to:

  • Connect to a running STK Desktop instance or launch a new one via the server's lifecycle management (src/stk_mcp/stk_logic/core.py).
  • Expose STK operations as MCP tools (defined in src/stk_mcp/tools/).
  • Create and configure STK scenarios using the setup_scenario tool.
  • Programmatically add and configure Satellite objects using the create_satellite tool.
  • Define satellite orbits using common orbital parameters.
  • Utilize the TwoBody propagator for orbit simulation within the tools.

Features (MCP Server)

  • MCP Server Implementation: Uses FastMCP within src/stk_mcp/server.py.
  • Modular Structure: Code organized into server setup (server.py), STK interaction logic (stk_logic/), and MCP tools (tools/).
  • STK Desktop Integration: Automatically connects to or starts STK 12 (requires Windows) when the server starts, managed via MCP lifespan.
  • Scenario Management Tool (setup_scenario): Creates new scenarios, sets analysis time periods, and closes any pre-existing scenario.
  • Satellite Creation Tool (create_satellite): Adds Satellite objects to the currently active scenario.
  • Orbit Definition: Configures satellite orbits using Apogee/Perigee Altitude, RAAN, and Inclination.
  • TwoBody Propagation: Sets up and runs the TwoBody propagator for created satellites.

Prerequisites

  • Operating System: Windows (due to STK Desktop and win32com dependency).
  • Python: Version 3.12 or higher.
  • Ansys/AGI STK: Version 12.x Desktop installed.
  • STK Python API: The agi.stk12 Python wheel corresponding to your STK installation must be installed. This typically involves:
    • Locating the wheel file (e.g., agi.stk12-py3-none-any.whl) within your STK installation directory (often under CodeSamples\Automation\Python).
    • Installing it using pip: uv pip install path/to/agi.stk12-py3-none-any.whl
  • Project Dependencies: Requires the mcp library (installed via uv sync).

Installation

  1. Clone the repository:
    git clone <repository-url>
    cd stk-mcp
    
  2. Ensure Prerequisites are met: Install Python, STK Desktop, and the STK Python API wheel as described above.
  3. Install project dependencies:
    # Install dependencies defined in pyproject.toml (includes mcp[cli])
    uv sync
    

Usage (MCP Server)

The MCP server logic is now structured within the src/stk_mcp directory. You interact with it using an MCP client or development tools.

  1. Ensure STK Desktop is closed (the server will launch its own instance via the lifespan manager).
  2. Run the MCP server in development mode:
    • Option A (Using the helper script):
      python scripts/run_dev.py
      
    • Option B (Directly using mcp command from the project root):
      mcp dev src/stk_mcp/server.py
      
    • The server will start, attempt to launch/connect to STK, and print logs.
    • STK Desktop should become visible.
    • The server listens for MCP connections.
  3. Interact with the Server (Example using MCP Inspector):
    • Open the MCP Inspector URL provided in the console (e.g., http://127.0.0.1:8765).
    • Find the "STK Control" server.
    • Use the "Tools" section to execute setup_scenario and create_satellite as before.
  4. Stop the Server: Press Ctrl+C in the terminal where the server is running. The lifespan manager will attempt to close STK.

MCP Tools Available

  • setup_scenario: (Defined in src/stk_mcp/tools/scenario.py)
    • Description: Creates/Configures an STK Scenario. Closes any existing scenario first.
    • Arguments: scenario_name (str, default: "MCP_STK_Scenario"), start_time (str, default: "20 Jan 2020 17:00:00.000"), duration_hours (float, default: 48.0).
  • create_satellite: (Defined in src/stk_mcp/tools/satellite.py)
    • Description: Creates or modifies an STK satellite. Assumes a scenario is active.
    • Arguments: name (str), apogee_alt_km (float), perigee_alt_km (float), raan_deg (float), inclination_deg (float).

Future Development (MCP Server & Expanded Automation)

Planned enhancements include:

  • Adding Ground Locations: MCP tool to add a Facility or Place object.
  • Resource Endpoints: Add MCP resources (e.g., get_scenario_details, list_objects) to query STK state.
  • Enhanced Satellite/Object Definition: More comprehensive configuration options.
  • Access Analysis Tool: Compute and report access between objects.
  • Error Handling: More robust error reporting back to the MCP client.

Dependencies

  • agi.stk12: For interacting with STK Desktop (Requires manual installation from STK).
  • mcp[cli]>=1.6.0: Model Context Protocol library.
  • pywin32: Automatically installed on Windows; used for COM interactions via win32com.client.

Limitations

  • Windows Only: Relies heavily on STK Desktop automation via COM.
  • STK Desktop Required: Does not currently support STK Engine.
  • Basic Functionality: Currently limited to scenario setup and basic satellite creation.
  • Single Scenario Focus: Assumes interaction with a single active scenario managed by the setup_scenario tool.

Contributing

Contributions are welcome! Please see the CONTRIBUTING.md file for guidelines.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mseep_stk_mcp-0.1.1.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mseep_stk_mcp-0.1.1-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file mseep_stk_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: mseep_stk_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for mseep_stk_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 048d8b467fabedea09e9929b63658e2f67d32c62c00170b63fc274e9e5e8ac00
MD5 11be9cd346133ee37ca85f16581a1f3a
BLAKE2b-256 1ecc97233991dfd480e115f8179dcfd6951d41d78bd572c880d1f3b1fa5e74ce

See more details on using hashes here.

File details

Details for the file mseep_stk_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: mseep_stk_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for mseep_stk_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 64b6e6cfef450d5133e1e8a9bed206de78ca69f7b1bd0d20af45e74cdbefa531
MD5 e275a26bdb87066452a1043b47a47d88
BLAKE2b-256 e6f5e9dc71aeb46d22df24ac77b32a917f530ff37636676aa16743bd5aab6a71

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page