Skip to main content
Glama

Create goal

create_gol

Creates a new goal document by assigning an ID, deriving a filename from the body's H1 title, validating the body, and writing it to the goal base directory. Returns frontmatter only.

Instructions

Create a new goal: assigns a fresh id, derives a filename from the body's H1 title, validates the submitted body-only content, and writes the new document to the goal base directory. A content-validation failure of the submitted body returns a non-raising ValidateResult (valid=False, a single errors[].message capped at 300 chars as the generic validate tool caps it, feat-110) instead of raising AssertionError/pydantic.ValidationError (ADR f14f125e-eaad-4f4f-a6fd-3c931bed726e, GitHub issue #204 -- case 5 of the ADR 519d1206 non-raising-structured-result workaround chain); nothing is written in that case. Returns the newly created document's frontmatter only (no body); use the corresponding get_gol tool to fetch the full document afterward.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.36.0

TDQS

A3.7/5.0
Behavior4/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 well: it discloses id assignment, filename derivation from the H1, that a validation failure returns a non-raising ValidateResult and writes nothing, and that only frontmatter (not the body) is returned. The remaining shortfall is the heavy embedding of internal ADR UUIDs and issue numbers (ADR f14f125e..., ADR 519d1206, issue #204, feat-110) that are not actionable for the calling agent.

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

Conciseness2/5

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

The operative behavior is front-loaded in the first sentence, but the second sentence is a dense run-on of implementation trivia—ADR UUIDs, GitHub issue numbers, 'case 5 of the ADR 519d1206 non-raising-structured-result workaround chain'—that costs the reader without helping tool selection. Much of this should be dropped or tightened.

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?

An output schema exists, so return-value explanation is optional, yet the description usefully notes frontmatter-only return and the follow-up get_gol call. The mutation path (nothing written on validation failure) is covered, leaving only parameter-format detail as a minor gap.

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 description coverage is 0% for the single `content` parameter, so the description must compensate. It partially does by clarifying this is body-only content and that the H1 title drives the filename, but it never names the parameter explicitly or states format constraints (e.g. markdown vs plain text), leaving a gap.

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 first clause states a specific verb (Create) and resource (goal), and the surrounding detail (assigns id, derives filename, validates body, writes to goal base directory) makes it unmistakably distinct from siblings like get_gol, list_gol, and parse_gol. An agent can identify the operation without inspecting the schema.

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?

Usage is implied (create a new goal document) and it routes the agent to get_gol for the full document afterward. However, there is no explicit when-to-use guidance relative to the other create_* tools, nor any stated preconditions such as required permissions or where the base directory lives.

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