Skip to main content
Glama

export_plan

Exports a plan document from its ingested manifest as an editable, re-ingestable structure, so you can review its contents, share it, or use it as a starting point for revisions.

Instructions

Export a plan's document, rendered from its ingested manifest.

Returns the plan document in the same shape save_plan accepts - {"repo_root", "role_config", "team", ["repo_url", "preflight_override",] "epics": [{"summary", "stories": [...]}]} - with each story's key, summary, description, agent_instructions, dependencies, persona, model, acceptance, risk, backend, tdd_split and (when set) files and blocked_by. Dependencies are the plan's own story keys, not the ticketing provider's issue ids, so the export can be edited and re-ingested as a plan.

This is a render, not a stored copy (ADR 0012 decision 5: the document is rendered from the manifest when an export is wanted). Runtime state - status, attempts, pr_url, worktree, review verdicts and scores, logs, approvals, owner, delegates, ingest provenance - is never exported; it is not part of the plan. A plan that was never ingested answers {"ok": false, "error": "Plan not found"}, and a plan the caller may not see gets that same reply from the transport's plan-scoped check, so the tool is no existence oracle.

plan_name: the plan's name, as passed to save_plan/ingest_plan and as returned by list_plans.

Use this to review what a plan actually says, to hand it to another tool or person, or as the starting point for a revised plan.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "plan_name": "<plan_name>"
    },
    "name": "export_plan"
  }
}

Input Schema

NameRequiredDescriptionDefault
plan_nameYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.10.0

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so: it discloses that this is a render not a stored copy (with the ADR citation), enumerates exactly which fields are exported and which runtime state is excluded, and documents the failure path ('Plan not found') as well as the non-oracle property of the plan-scoped authorization check. That is precisely the behavioral context an agent needs before calling.

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?

Front-loaded with purpose and return shape, then separated into a behavior paragraph and a trailing parameter definition — easy to scan. It is somewhat verbose: the long field enumeration and shape literal largely restate what the output schema already carries, which is the one place words are not fully earning their place.

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?

Covers the read-only render semantics, the exact exported field set, the excluded runtime state, the error reply, and the authorization behavior — everything needed for a one-parameter but semantically loaded tool. Return-value detail is arguably duplicated with the output schema, but that is surplus rather than a gap.

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

Parameters5/5

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

Schema coverage is 0% and the single parameter has no description in the schema, so the description must compensate — and it does, defining plan_name as the plan's name as passed to save_plan/ingest_plan and as returned by list_plans, which tells the agent exactly where to obtain a valid value.

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?

Opens with a specific verb and resource: 'Export a plan's document, rendered from its ingested manifest.' It immediately frames the round-trip relationship to save_plan ('the same shape `save_plan` accepts') and implicitly separates itself from list_plans by noting plan_name is 'as returned by `list_plans`', so an agent can place it without opening a schema.

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

Usage Guidelines4/5

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

Names three concrete use cases ('review what a plan actually says', 'hand it to another tool or person', 'starting point for a revised plan') and frames the save_plan round trip. It also implicitly excludes runtime monitoring by stating status/attempts/logs are never exported, though it never names the alternative tools (e.g. get_story_log, check_story_status) an agent should use instead.

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