Skip to main content
Glama

Create instruction

create_instruction

Create an instruction document on a project, freely titled (there is no fixed set), with its full text when known. Titles are unique within the project. During an active workflow run, instruction changes are accepted only in its self-improvement stage. Returns its id for update_instruction.

Input Schema

NameRequiredDescriptionDefault
titleYesInstruction title, unique in the Project.
contentNoFull Instruction text, with lists instead of tables.
projectIdYesId of the Project.
requestIdNoOptional unique ID for this create. After a timeout, retry with the same requestId and arguments: the record already created is returned instead of a duplicate.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / content / description
      Previous value: -"Full Instruction text."New value: +"Full Instruction text, with lists instead of tables."
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations declare a non-destructive write (readOnlyHint=false, destructiveHint=false, openWorldHint=false), and the description adds meaningful behavior beyond that: title uniqueness within the project, the workflow-stage gating rule, and the returned id. It does not say what happens on a duplicate title (error vs. merge) or whether the create is idempotent, leaving some behavioral gaps.

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?

Four compact sentences, front-loaded with the core action and followed by constraints and the return pointer. Little waste; each sentence carries distinct information, though the phrasing is slightly terse.

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?

There is no output schema, but the description compensates by stating what is returned (its id) and how it is used (for update_instruction). Combined with 100% schema coverage and explicit annotations, the definition is sufficient to call the tool correctly; only duplicate-title and idempotency behavior are left unstated.

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 100%, so the schema already documents all four parameters including the requestId retry semantics. The description only loosely restates title ("freely titled") and content ("full text when known") without adding format or constraint detail, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Create an instruction document on a project") and adds a differentiator ("freely titled (there is no fixed set)") that separates it from structured-schema siblings like create_dictionary_term or create_rule. It does not name any sibling directly, but an agent can identify the operation without opening 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?

Provides one real usage constraint — during an active workflow run, instruction changes are accepted only in its self-improvement stage — and points to the follow-up tool (update_instruction) via the returned id. It never states when to choose create_instruction over create_info or similar document-creating siblings, so guidance is partial and 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.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources