yade-mcp

Browse YADE Python API documentation hierarchically.

Navigate category → class → details, like a filesystem:

• Empty path: list categories (ls /)

• Category: list classes (ls /engines)

• Category.Class: full documentation (cat /engines/NewtonIntegrator)

Search YADE API documentation by keywords (like grep).

Returns matching class/function names with descriptions ranked by relevance. Use yade_browse_api for full documentation of a specific class.

When to use:

• You have keywords but don't know the exact class name

• Examples: "friction material", "gravity engine", "contact force", "triaxial stress", "sphere create", "hertz mindlin"

Related tools:

• yade_browse_api: Get full documentation for a known class path

Submit a Python script for asynchronous execution in YADE.

Returns a task_id immediately; the script runs in the background. Use the companion tools to manage the task lifecycle:

• yade_check_task_status: poll output, progress, and final status

• yade_interrupt_task: cancel a running task

• yade_list_tasks: browse task history

Use this for production simulation runs, long O.run() cycles, and any operation that may take minutes or longer. For quick queries and REPL-style testing, use yade_execute_code.

Check status and output for a submitted YADE task.

List tracked YADE tasks with pagination.

Request graceful interruption of a running YADE task.

Execute Python code synchronously in the running YADE process.

Returns stdout immediately. Code runs in the YADE Python environment where yade modules are already imported; side effects persist.

Typical uses:

• Query simulation state: O.bodies count, current iteration

• Create/modify bodies, engines, interactions

• Read or set material properties

• Development and REPL-style testing

Unlike yade_execute_task, this tool is fire-and-return: the response contains the full output. It is NOT tracked by yade_list_tasks and cannot be interrupted or polled.

WARNING: Avoid long-running calls (O.run with many iterations, heavy loops). They block until completion or timeout and cannot be cancelled. Use yade_execute_task for long simulations.