Skip to main content
Glama

Set entities

set_entities

Define up to 12 entities with roles, colors, symbols, and sections from your materials. Configure autolinking for entity, environment, or theme pages.

Instructions

Define the entity axis (the chips): ≤12 entities [{id, name, role?, color?, symbol_svg?, sections?: [{h,t,prov?}], aliases?: [str], sources?: [source id]}]. In outline mode give each entity sections on how it is satisfied, from the material, where the material says — otherwise its page lists concepts only. autolink picks which kinds of page are linked by name in running text: any of 'char' (these entities), 'env', 'theme' (default ['env','theme']); autolink_overview false leaves the Overview unlinked. Omitted colors get a clean palette. Design a unique symbol_svg per entity (guide §C1 has the rules and the exact wrapper) — entities without one all share the same fallback ◆ and become indistinguishable. Detail-page sections must come verbatim from the user's materials (§0).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
autolinkNo
entitiesYes
timeline_idYes
autolink_overviewNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.8.22
    • addedInput schema / properties / autolink
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Autolink"
      +}
    • addedInput schema / properties / autolink_overview
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Autolink Overview"
      +}
  2. First observedv1.4.0

TDQS

A4.3/5.0
Behavior5/5

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

The description discloses a hard cap of 12 entities, automatic palette assignment for omitted colors, and the important consequence that missing unique symbol_svg values make entities indistinguishable. It also constrains detail-page sections to come verbatim from user materials, which goes well beyond the minimal annotations.

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 dense but every clause earns its place: the inline entity schema, outline-mode rule, autolink semantics, symbol fallback warning, and verbatim-materials constraint are all useful. The most identifying information is front-loaded, and there is no filler.

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?

The description is largely complete for a mutation tool, covering the entity model, constraints, autolink options, overview behavior, and symbol requirements. However, it relies on external guide references (Section C1 and Section 0) and does not explain timeline_id or the response behavior, so it is not fully self-contained.

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

Parameters5/5

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

With zero schema-level descriptions, the description compensates by specifying the full entity array structure, the valid autolink values with their default, and the effect of autolink_overview=false. timeline_id is left to its name, but the other parameters are explained far more precisely than the schema alone provides.

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?

The description opens with a specific verb, 'Define', and names the exact resource, 'the entity axis (the chips)', followed by the entity object shape. This is clear enough to distinguish it from sibling tools like set_axis_values even without naming them, but it stops short of explicitly calling out that alternative.

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 includes conditional instructions, such as adding sections in outline mode and the autolink behavior, but it never states when an agent should choose this tool over set_axis_values, add_nodes, or add_connections. The intended usage is implied rather than made explicit.

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