Skip to main content
Glama

generate_initial_schema_preview

Preview a schema TOML by combining task analysis with an optional taxonomy file, without writing or modifying any files. Review and approve before saving.

Instructions

Generate a reviewable schema TOML preview without writing any files.

Read-only: returns a preview string only; no files are created or modified. Call save_initial_schema only after the user approves.

The preview combines existing task analysis with an optional taxonomy Markdown file. Run analyze_existing_tasks_for_schema or analyze_taxonomy_file first to understand what the preview will contain.

taxonomy_path: absolute path to a taxonomy Markdown file; omit to infer from tasks only. project_dir: optional path scoping task analysis to a subdirectory. schema_name: optional name embedded in the schema [meta] block.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
taxonomy_pathNo
project_dirNo
schema_nameNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

With no annotations, the description serves as the sole source for behavioral traits. It explicitly states 'Read-only: returns a preview string only; no files are created or modified', clearly communicating the tool's non-destructive nature.

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 well-structured with front-loaded purpose and read-only guarantee, followed by parameter details. It is mostly concise, though could slightly tighten wording (e.g., 'Call save_initial_schema only after the user approves' is clear but slightly redundant with the read-only note).

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?

Given the presence of an output schema (context signals indicate 'Has output schema: true'), the description appropriately focuses on prerequisites, behavior, and parameter guidance. It mentions the return type 'preview string', which aligns with the output schema expectation.

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?

Despite 0% schema description coverage, the description adds comprehensive meaning to all three parameters: taxonomy_path (absolute path or infer from tasks), project_dir (scope subdirectory), and schema_name (name in meta block), fully compensating for the schema's lack of descriptions.

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 clearly states the tool 'Generate a reviewable schema TOML preview without writing any files' using a specific verb and resource, and distinguishes it from sibling tool 'save_initial_schema' by noting it should be called only after user approval.

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?

The description provides explicit guidance on when to use this tool: after running 'analyze_existing_tasks_for_schema' or 'analyze_taxonomy_file', and before calling 'save_initial_schema'. It also explains the preview combines task analysis with optional taxonomy.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/GabiUp2/TaskChampion_MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server