Skip to main content
Glama

PlanExe

by io.github.PlanExeOrg

plan_status

Read-onlyIdempotent

Returns status and progress of the plan currently being created. This is the primary way to check progress — it returns structured JSON with all progress fields. Poll at reasonable intervals (e.g. every 5 minutes): plan generation typically takes 10-20 minutes (baseline profile) and may take longer on higher-quality profiles. State contract: pending/processing => keep polling; completed => download is ready; failed => terminal error; stopped => user called plan_stop (consider plan_resume). progress_percentage is 0-100 (integer-like float); 100 when completed. Note: steps vary in duration — early steps complete quickly while later steps (review, report generation) take longer. Do not use progress_percentage to estimate time remaining. steps_completed and steps_total give the number of plan generation steps completed and expected (both nullable). current_step is the human-readable label of the most recently completed step (e.g. 'SWOT Analysis'). timing.last_progress_at is an ISO 8601 timestamp of the last progress update (null until the first worker update); use it to compute time-since-last-progress and detect stalls — a gap > 10 minutes with no progress change is a strong stall signal. files lists the most recent 10 intermediate outputs produced so far (files_count gives the total); use their updated_at timestamps as a secondary stall signal. When state is 'failed', the response includes an error dict with failure diagnostics: error.failure_reason (category: generation_error, worker_error, inactivity_timeout, internal_error, version_mismatch), error.failed_step (pipeline step active at failure), error.message (human-readable message), and error.recoverable (true => plan_resume may work, false => use plan_retry). The error dict is absent for non-failed states. Unknown plan_id returns error code PLAN_NOT_FOUND. Troubleshooting: pending for >5 minutes likely means queued but not picked up by a worker. processing with timing.last_progress_at unchanged for >10 minutes likely means stalled — call plan_stop then plan_retry. Fall back to file updated_at timestamps if last_progress_at is null. Report these issues to https://github.com/PlanExeOrg/PlanExe/issues .

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
plan_idYesPlan UUID returned by plan_create.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
-  "$defs": {
-    "ErrorDetail": {
-      "properties": {
-        "code": {
-          "title": "Code",
-          "type": "string"
-        },
-        "details": {
-          "anyOf": [
-            {
-              "additionalProperties": true,
-              "type": "object"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "default": null,
-          "title": "Details"
-        },
-        "message": {
-          "title": "Message",
-          "type": "string"
-        }
-      },
-      "required": [
-        "code",
-        "message"
-      ],
-      "title": "ErrorDetail",
-      "type": "object"
-    },
-    "PlanStatusFile": {
-      "properties": {
-        "path": {
-          "title": "Path",
-          "type": "string"
-        },
-        "updated_at": {
-          "title": "Updated At",
-          "type": "string"
-        }
-      },
-      "required": [
-        "path",
-        "updated_at"
-      ],
-      "title": "PlanStatusFile",
-      "type": "object"
-    },
-    "PlanStatusTiming": {
-      "properties": {
-        "elapsed_sec": {
-          "title": "Elapsed Sec",
-          "type": "number"
-        },
-        "started_at": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "title": "Started At"
-        }
-      },
-      "required": [
-        "started_at",
-        "elapsed_sec"
-      ],
-      "title": "PlanStatusTiming",
-      "type": "object"
-    }
-  },
-  "properties": {
-    "error": {
-      "anyOf": [
-        {
-          "$ref": "#/$defs/ErrorDetail"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null
-    },
-    "files": {
-      "anyOf": [
-        {
-          "items": {
-            "$ref": "#/$defs/PlanStatusFile"
-          },
-          "type": "array"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null,
-      "description": "Intermediate output files produced so far. Use updated_at timestamps to detect stalls. These files are included in the zip artifact when the plan completes.",
-      "title": "Files"
-    },
-    "plan_id": {
-      "anyOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null,
-      "description": "Plan UUID returned by plan_create.",
-      "title": "Plan Id"
-    },
-    "progress_percentage": {
-      "anyOf": [
-        {
-          "type": "number"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null,
-      "description": "Completion progress from 0 to 100. Monotonically increasing; 100 when state is completed.",
-      "title": "Progress Percentage"
-    },
-    "sse_url": {
-      "anyOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null,
-      "description": "GET endpoint (text/event-stream) for real-time progress. Available when plan is not in a terminal state. See plan_create sse_url description for usage.",
-      "title": "Sse Url"
-    },
-    "state": {
-      "anyOf": [
-        {
-          "enum": [
-            "pending",
-            "processing",
-            "completed",
-            "failed"
-          ],
-          "type": "string"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null,
-      "description": "Caller contract: pending/processing => keep polling; completed => download is ready; failed => terminal error.",
-      "title": "State"
-    },
-    "timing": {
-      "anyOf": [
-        {
-          "$ref": "#/$defs/PlanStatusTiming"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null
-    }
-  },
-  "title": "PlanStatusOutput",
-  "type": "object"
-}New value: +null
  2. Changed1 schema field changed
    • addedOutput schema / properties / sse_url
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "GET endpoint (text/event-stream) for real-time progress. Available when plan is not in a terminal state. See plan_create sse_url description for usage.",
+  "title": "Sse Url"
+}
  3. Changed6 schema fields changed
    • addedInput schema / properties / plan_id
      Added value: +{
+  "description": "Plan UUID returned by plan_create.",
+  "title": "Plan Id",
+  "type": "string"
+}
    • removedInput schema / properties / task_id
      Removed value: -{
-  "description": "Task UUID returned by plan_create.",
-  "title": "Task Id",
-  "type": "string"
-}
    • changedInput schema / required
      Previous value: -[
-  "task_id"
-]New value: +[
+  "plan_id"
+]
    • changedOutput schema / properties / files / description
      Previous value: -"Intermediate output files produced so far. Use updated_at timestamps to detect stalls. These files are included in the zip artifact when the task completes."New value: +"Intermediate output files produced so far. Use updated_at timestamps to detect stalls. These files are included in the zip artifact when the plan completes."
    • addedOutput schema / properties / plan_id
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Plan UUID returned by plan_create.",
+  "title": "Plan Id"
+}
    • removedOutput schema / properties / task_id
      Removed value: -{
-  "anyOf": [
-    {
-      "type": "string"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Task UUID returned by plan_create.",
-  "title": "Task Id"
-}
  4. Added

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare read-only, idempotent, non-destructive, but the description adds substantial behavioral context: the full state machine (pending/processing/completed/failed/stopped), exact error dict structure, stall detection heuristics (>10 minutes), queuing threshold (>5 minutes), and the note that progress_percentage is an integer-like float. It even discloses that steps vary in duration, so time estimation is unreliable. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but well-organized into a coherent flow: core purpose, state contract, field explanations, troubleshooting thresholds, and error diagnostics. It front-loads the key message and every sentence carries actionable information. Slight verbosity in repeating timing-related mentions (last_progress_at, updated_at) could be tightened, but the density justifies the length.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description fully carries the burden of explaining the response shape, including all progress fields, the error dict, nullable fields, and timing semantics. It covers every state, provides concrete threshold values for detecting stalls/queues, and even links to the issue tracker for troubleshooting. This is complete for a complex state-monitoring tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter plan_id is fully described in the schema ('Plan UUID returned by plan_create'), giving 100% schema coverage. The description adds only a minor behavioral detail about the PLAN_NOT_FOUND error for unknown plan_id, which is useful but not essential. Since the schema already carries the semantic weight, the description provides no significant additional parameter-level meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a clear and specific statement: 'Returns status and progress of the plan currently being created.' This names the exact resource (plan status) and the action (returns status/progress), and it differentiates from siblings like plan_list (list plans) and plan_file_info (file info) by highlighting 'currently being created' and 'primary way to check progress.'

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly positions itself as the primary progress-check tool and provides detailed polling guidance (every 5 minutes), state-contract triggers (keep polling, download ready, terminal error), and remediation steps (use plan_stop then plan_retry on stall; plan_resume on recoverable failure). It also advises using file updated_at as a fallback, giving clear when-to-use and when-to-alternate guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All PlanExe toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.6/5.0
Disambiguation5/5

Each tool has a distinct, non-overlapping purpose within the PlanExe workflow. For example, example_plans and example_prompts serve different preparatory functions, while plan_create, plan_status, plan_stop, plan_resume, and plan_retry handle distinct lifecycle stages of plan generation. No tools appear to duplicate functionality, making selection clear for an agent.

Naming Consistency5/5

Tool names follow a highly consistent verb_noun pattern throughout, with all tools using snake_case and clear action-object pairs (e.g., plan_create, plan_status, plan_stop). The naming is predictable and readable, with no deviations in style or convention across the set.

Tool Count5/5

With 11 tools, the server is well-scoped for its purpose of generating and managing strategic project plans. Each tool serves a specific role in the workflow, from preparation (example_prompts, model_profiles) to creation (plan_create), monitoring (plan_status), lifecycle management (plan_stop, plan_resume, plan_retry), and feedback (send_feedback). The count is appropriate and avoids bloat or gaps.

Completeness5/5

The tool set provides complete coverage for the plan generation domain, including CRUD-like operations (create, list, status, stop, resume, retry) and supporting functions (examples, model selection, file retrieval, feedback). There are no obvious gaps; agents can handle the entire lifecycle from prompt drafting to plan retrieval and error recovery without dead ends.

Resources