Skip to main content
Glama

investigation_log

Append hypotheses, experiments, observations, ruled-out ideas, and notes to an open investigation log, recording experiment commands before execution and results after.

Instructions

WRITE. Append to the open investigation. kind: hypothesis, experiment, observation, ruled_out (with a one-line reason), note. An experiment needs command (logged BEFORE running it) and gets result good/bad/inconclusive after; anchor defaults to the current HEAD(+.config). One entry per experiment, never a summary of several.

Input Schema

NameRequiredDescriptionDefault
kindYes
refsNo
textYes
anchorNo
resultNo
commandNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/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 behavioral burden and does substantial work: it declares write semantics, the ordering discipline (command logged BEFORE execution, result afterward), the default anchor, and the one-entry-per-experiment invariant. It omits what happens if no investigation is open and whether entries can be amended or removed.

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?

Front-loaded with the operation type and tightly written; nearly every clause carries a distinct rule. The telegraphic shorthand 'HEAD(+.config)' and the compressed kind list border on cryptic, which costs it a point on clarity despite the efficiency.

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?

Output schema exists, so return values need no explanation, and the description covers the mutation workflow, entry taxonomy, and sequencing rules well for a 6-parameter write tool with no annotations. The unaddressed `refs` parameter and undefined failure behavior (no open investigation) are the remaining gaps.

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 0%, so the description must compensate. It defines `kind`'s valid values, explains `command` and `result` including their enumeration (good/bad/inconclusive), and gives `anchor`'s default. However, `refs` — an opaque anyOf array of free-form objects — is never mentioned, and `text` is left implicit.

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?

Opens with 'WRITE. Append to the open investigation.' — a specific verb, resource, and scope (the *open* investigation) that separates it from read-oriented siblings like investigation_status and from the lifecycle siblings investigation_open/close. An agent can tell immediately this creates log entries rather than reading or closing an investigation.

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

Usage Guidelines4/5

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

Gives strong conditional guidance: which `kind` values exist, that `ruled_out` requires a one-line reason, and that an experiment needs `command` logged before running with `result` recorded after. It also forbids batching ('one entry per experiment, never a summary of several'). It does not name sibling alternatives (checkpoint, store_memory, investigation_status), so it stops short of a 5.

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