# YADE MCP Server

> YADE MCP Server is an open-source MCP server for engineering simulation. Let an agent browse the YADE docs, run discrete element simulations and manage tasks. It runs locally on your machine and is started by your AI client.

- **Kind:** MCP server
- **Pricing:** Open source
- **Platforms:** CLI, Linux
- **Repository:** https://github.com/yusong652/yade-mcp
- **MCP Registry name:** io.github.yusong652/yade-mcp
- **Categories:** [engineering simulation](https://ai-powered.com/categories/engineering-simulation)
- **Listing updated:** 2026-11-18

## About

YADE is an open-source discrete element method engine, and this server connects an agent to a live YADE session through a small bridge that you install into YADE's own Python. Two documentation tools work without it: one walks the Python class tree and one runs a BM25 keyword search across the API. The five execution tools need the bridge started in the YADE console.

Code runs in the session's own namespace, so state persists between calls, and it keeps working while a background task runs, which lets an agent read the unbalanced force without stopping a simulation. Long scripts are submitted as queued tasks that run one at a time and can be stopped at an iteration boundary. Task history persists across sessions, and lines you type at the YADE console reach the agent on its next call.

Prerequisites are YADE and uv, and the README warns the bridge must be installed with the interpreter YADE embeds, not a conda or venv one. The bridge listens on port 9002 by default and can bind to all interfaces inside a container. MIT licensed.

## Features

- **API browsing:** Walk the YADE Python class tree without the bridge.
- **API search:** BM25 keyword search across the API corpus.
- **Live REPL:** Run Python in the running YADE process with persistent state.
- **Background tasks:** Submit long scripts, queue them and interrupt at an iteration boundary.
- **Task history:** Scripts, output and final states persist across sessions.
- **Console input:** Lines typed at the YADE console reach the agent.

## Good for

- Set up a triaxial compression test and plot stress against strain
- Build an irregular particle and drop it onto a plane
- Check a running simulation's unbalanced force
- Look up how a timestepper works before using it
- Review what was run yesterday and what it produced

## Install

### Claude Code (Terminal)

```sh
claude mcp add yade-mcp -- uvx yade-mcp
```

### Claude Desktop (claude_desktop_config.json)

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

### Cursor (~/.cursor/mcp.json)

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

### VS Code (.vscode/mcp.json)

```json
{
  "servers": {
    "yade-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "yade-mcp"
      ]
    }
  }
}
```

### Windsurf (~/.codeium/windsurf/mcp_config.json)

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

### Other clients (your client's MCP settings (most use this shape))

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

## Tools

- `yade_browse_api`: Walk the YADE Python class tree.
- `yade_query_api`: BM25 keyword search across the YADE API.
- `yade_execute_code`: Run Python in the live YADE process and return synchronously.
- `yade_execute_task`: Submit a script as a long-running background task.
- `yade_check_task_status`: Inspect a running or finished task.
- `yade_interrupt_task`: Stop a running task at an iteration boundary or cancel a queued one.
- `yade_list_tasks`: List submitted tasks with metadata.

## FAQ

### What do I need installed?

YADE, the uv launcher and an MCP-capable agent such as Claude Code, Codex CLI or Gemini CLI.

### Do the docs tools need the bridge?

No, only the five execution tools do.

### Where does the bridge listen?

On port 9002 by default; pass another port to start() and register a matching bridge URL.

### What licence is it under?

MIT.

### Is YADE MCP Server free?

Yes. YADE MCP Server is open source, so you can use and self-host it for free.

### How do I add YADE MCP Server to Claude Code?

Run this command in your terminal: claude mcp add yade-mcp -- uvx yade-mcp

### What are the best alternatives to YADE MCP Server?

The closest alternatives to YADE MCP Server are CAD2GIS, Petrolytx: decline curves and well economics, zumen-gate, Gradient Dynamics: thermal and CFD simulation and The Cable Code.

## Where this comes from

- Description: written from the project's README.
- Install steps: from the official MCP Registry entry.

## Alternatives

- [CAD2GIS](https://ai-powered.com/mcp/cad2gis): CAD2GIS is an open-source MCP server for engineering simulation.
- [Petrolytx: decline curves and well economics](https://ai-powered.com/mcp/petrolytx-decline-curves-and-well-economics): Petrolytx: decline curves and well economics is a freemium MCP server for analytics and data.
- [zumen-gate](https://ai-powered.com/mcp/zumen-gate): zumen-gate is a freemium MCP server for engineering simulation.
- [Gradient Dynamics: thermal and CFD simulation](https://ai-powered.com/mcp/gradient-dynamics-thermal-and-cfd-simulation): Gradient Dynamics: thermal and CFD simulation is an MCP server for engineering simulation.
- [The Cable Code](https://ai-powered.com/mcp/the-cable-code): The Cable Code is a freemium MCP server for engineering simulation.
- [naja-scope](https://ai-powered.com/mcp/naja-scope): naja-scope is an open-source MCP server for developer tools.
- [StructaCAD](https://ai-powered.com/mcp/structacad): StructaCAD is a paid MCP server for engineering simulation.
- [VextCAD](https://ai-powered.com/mcp/vextcad): VextCAD is a freemium MCP server for design and media.

---
Source: https://ai-powered.com/mcp/yade-mcp-server
