Skip to main content
Glama
etoyama

insight-blueprint

by etoyama

create_analysis_design

Create a new analysis design document as a YAML file with in_review status, capturing hypothesis, methodology, and metrics for structured review workflows.

Instructions

Create a new analysis design document.

Creates a YAML file in .insight/designs/ with 'in_review' status. theme_id must match [A-Z][A-Z0-9]* pattern (e.g., 'FP', 'TX', 'DEFAULT').

methodology: Analysis method dict with required 'method' key. Example: {"method": "OLS", "package": "statsmodels", "reason": "..."} WARNING: Should rarely be None — methodology is a core design field.

Returns: dict with id, title, status, message

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
chartNo
titleYes
metricsNo
theme_idNoDEFAULT
parent_idNo
explanatoryNo
methodologyNo
next_actionNo
analysis_intentNoconfirmatory
hypothesis_statementYes
referenced_knowledgeNo
hypothesis_backgroundYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

With no annotations, the description carries the full burden. It discloses the side effect (creating a YAML file), the initial status, the theme_id pattern validation, the methodology structure and warning, and the return value. It does not mention overwrite behavior or authorization, but provides solid behavioral detail beyond a simple create statement.

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?

The description is front-loaded with purpose, then provides essential details in a structured, line-broken format. Each sentence adds value: file location/status, theme_id pattern, methodology guidance with warning, and return type. No fluff or redundancy.

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

Completeness3/5

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

Given the tool's complexity (12 params, no schema descriptions, no annotations), the description offers important context like file creation and return value. However, it omits explanation for most parameters and does not cover required fields. It is adequate but incomplete, earning a 3 for missing significant portions of the parameter space.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate. It explains only theme_id and methodology in detail, with an example and pattern. However, the other 10 parameters (including required title, hypothesis_statement, hypothesis_background) are not described at all, leaving a significant gap for a 12-param tool with no property 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 explicitly states the tool creates a new analysis design document, with a specific verb and resource. It further distinguishes from siblings by noting it creates a YAML file in a specific directory with 'in_review' status, making it unique from get/update/list tools.

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?

The description implies usage for creating new designs without explicit alternatives. It mentions the initial status 'in_review' and warns about methodology, but does not explicitly state when to use this over update_analysis_design or transition_design_status. This is implied rather than explicit.

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/etoyama/insight-blueprint'

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