Yade MCP

What yusong652/yade-mcp MCP server does

The yusong652/yade-mcp MCP server exposes YADE functionality through the Model Context Protocol. YADE is an open-source discrete element method engine used for granular and particle simulation. An MCP-compatible agent can search YADE’s API documentation, execute Python code, submit scripts, inspect task output, and stop active work through separate tools.

The project divides its seven tools into two groups. yade_browse_api and yade_query_api provide documentation access without the bridge. The remaining tools interact with a running YADE process and therefore require the bridge to be active.

How it works

API exploration is available through class-tree navigation and BM25 keyword search. These tools can help an agent locate YADE classes and relevant API entries before it writes code.

For interactive work, yade_execute_code sends Python to the live YADE process and returns synchronously. This supports inspecting particles, changing parameters, stepping the engine, and examining variables or object state. It can also be used while a background task is running.

Long-running scripts use yade_execute_task. The task tools let an agent check status and output, list submitted tasks with metadata, and request a graceful interruption. Task records include the submitted script, live output, and final state, allowing a later session to review prior work.

Setup and configuration

The yusong652/yade-mcp MCP server requires YADE and uv. Register the server in the MCP client with uvx and the yade-mcp package:

{
  "mcpServers": {
    "yade-mcp": {
      "command": "uvx",
      "args": ["yade-mcp"]
    }
  }
}

Execution features also require installing yade-mcp-bridge with YADE’s own Python interpreter. After restarting YADE, import yade_mcp_bridge in the YADE Python console and call its start() function. The README notes that externally managed Python environments may need the project’s bootstrap guide instead of the basic user-level pip command.

After restarting the MCP client, verify the connection by asking the agent to call yade_execute_code.

Tools and capabilities

• Browse the YADE Python class hierarchy.
• Search the YADE API with BM25 keyword matching.
• Run Python synchronously in a live YADE process.
• Submit a script as a background task.
• Inspect running or completed task status and output.
• Interrupt a running task gracefully.
• List submitted tasks and their metadata.

Limitations and notes

The yusong652/yade-mcp MCP server does not provide bridge-backed execution until the bridge is installed and started inside YADE. Documentation browsing and API search are listed as bridge-free, but code execution and task management depend on that connection.

The supplied setup requires YADE to be installed separately; the MCP package does not replace the YADE installation. The README identifies Python 3.10 or newer for the project and documents verification with several command-line and coding agents, while the exact client configuration format may vary between MCP clients.