Skip to main content
Glama
Sign In
patchwork-os

patchwork-os

by Oolab-labs
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

getPlan

Read-only

Read a plan file to retrieve its title, sections, tasks, and completion status.

Instructions

Read plan file. Returns title, sections, tasks, and completion status.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "getPlan"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileNameNoPlan filename (default: .claude-plan.md)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already provide readOnlyHint=true, so no contradiction. Description adds return fields but does not disclose behavior on missing file or other side effects. Adequate but minimal beyond annotations.

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

Conciseness5/5

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

Two short, direct sentences with no fluff. Front-loaded with the core action and output. Every word adds value.

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

Completeness4/5

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

No output schema, but description explains return fields (title, sections, tasks, completion status). Lacks details on error handling or default filename behavior, but sufficient for a simple read 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?

Schema coverage is 100%; the single optional parameter is already described in the schema. The description does not add extra meaning beyond what schema provides.

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?

Clearly states it reads a plan file and returns specific fields (title, sections, tasks, completion status). Distinguishes from sibling tools like createPlan, updatePlan, deletePlan, listPlans by being a read operation.

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

Usage Guidelines3/5

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

Implied usage as a read-only operation, but no explicit guidance on when to use versus alternatives (e.g., to modify use updatePlan). Agent can infer from context but lacks direct hints.

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

Deploy Server

Other Tools