Skip to main content
Glama

create_entity

Create an observation, rule, or knowledge entity to store AI agent findings, directives, or reference docs in CogZ's knowledge layer.

Instructions

Create a knowledge-layer entity. entity_type picks the lifecycle, not the topic — ask what the entry IS: 'observation' = something that happened (bug found, surprising behavior, decision noticed) — raw, append-only, unvalidated; consolidation promotes the good ones to rules. 'rule' = a verified directive agents must always follow (conventions, constraints) — pushed into every context pack; change via supersede, not edits. 'knowledge' = a curated reference doc (architecture, gotchas, design decisions) — the only editable type (update_knowledge). Requires: content always; title+category for knowledge.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoYesAbsolute path to the project root containing `.cogz/`.
tagsNo`knowledge` only.
titleNoTitle. Required for `knowledge`; auto-generated for observation/rule when omitted.
sourceNo`observation` only: who or what produced it. Default: "agent".
contentYesEntity body. Required for all types.
categoryNoCategory — required for `knowledge` (e.g. architecture, decisions, gotchas). Ignored otherwise.
confidenceNo`rule` only: confidence 0..1.
referencesNoUUIDs of entities this entry references (code or knowledge).
entity_typeYesWhich lifecycle class to create: `observation` (raw finding, append-only, unvalidated), `rule` (verified directive, always delivered in packs, supersede to change), or `knowledge` (curated reference doc, editable via update_knowledge).
supporting_idsNo`observation` only: UUIDs of observations this one supports — creates `supports` edges for promotion consolidation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.6

TDQS

A4.1/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full behavioral burden, and it does substantial work: observation is append-only/unvalidated with consolidation promoting good ones, rules are pushed into every context pack and changed via supersede rather than edits, knowledge is the only editable type. It omits permissions/auth needs and any notion of the create response, but the lifecycle consequences are unusually well disclosed.

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 core action, then organized by entity_type with em-dash clauses that keep related facts together. It is information-dense and slightly long, but every clause (lifecycle, editability, promotion) earns its place, so no significant waste.

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?

For a 10-parameter create tool with no output schema and no annotations, the description covers the behavioral model thoroughly and summarizes the required fields. Return-value details are unnecessary given no output schema, though the absence of any auth/permission note leaves a small 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 100%, so the schema already documents all 10 parameters; the description only restates the requirements ("content always; title+category for knowledge"). That summary is useful but adds little beyond what the schema fields already say, so the baseline 3 is appropriate.

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?

States a specific verb+resource ("Create a knowledge-layer entity") and then disambiguates the lifecycle meaning of entity_type far beyond a tautology, explicitly noting that entity_type selects the lifecycle, not the topic. It distinguishes the three resulting lifecycles clearly enough that an agent can tell what kind of object it is producing.

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 per-type usage guidance ('observation' = raw append-only, 'rule' = verified directive, 'knowledge' = editable doc) and routes the agent to siblings — 'change via supersede, not edits' and 'the only editable type (update_knowledge)'. It lacks an explicit when-not-to-create statement, so it falls short of the top band, but the conditions for each branch are clear.

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