Skip to main content
Glama

record_synthesis

Destructive

Saves or updates a synthesis entity page from next_synthesis, replacing the stored page with a new page or only changed sections for auditable medical literature reviews.

Instructions

Save an entity page from next_synthesis, replacing the stored one: a new page, or only the changed sections of an update. Rules: guide("synthesis").

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "entity_id": "<entity_id>",
      "input_digest": "<input_digest>"
    },
    "name": "record_synthesis"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectNoProject name from list_projects; may be omitted when only one project exists
summaryNo2-3 sentence overview; for an update only if it changes
sectionsNoUpdate: only the changed sections, as {heading: full new section text}; an empty text removes a section
entity_idYesFrom next_synthesis
synthesisNoNew page: Markdown with '## ' sections, citing sources as [uid] and linking entities as [[Name]]
key_aspectsNo
input_digestYesFrom next_synthesis
related_entitiesNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.3.0
    • removedInput schema / $defs
      Removed value: -{
      -  "RelatedEntity": {
      -    "additionalProperties": false,
      -    "properties": {
      -      "entity_type": {
      -        "anyOf": [
      -          {
      -            "enum": [
      -              "CONDITION",
      -              "INTERVENTION",
      -              "TECHNOLOGY",
      -              "METHOD",
      -              "GUIDELINE",
      -              "DATASET",
      -              "CONCEPT",
      -              "PERSON",
      -              "ORGANIZATION",
      -              "PLACE"
      -            ],
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "title": "Entity Type"
      -      },
      -      "name": {
      -        "title": "Name",
      -        "type": "string"
      -      },
      -      "relationship_type": {
      -        "default": "",
      -        "title": "Relationship Type",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "name"
      -    ],
      -    "title": "RelatedEntity",
      -    "type": "object"
      -  }
      -}
    • changedInput schema / properties / related_entities / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "$ref": "#/$defs/RelatedEntity"
      -    },
      -    "maxItems": 30,
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "entity_type": {
      +          "anyOf": [
      +            {
      +              "enum": [
      +                "CONDITION",
      +                "INTERVENTION",
      +                "TECHNOLOGY",
      +                "METHOD",
      +                "GUIDELINE",
      +                "DATASET",
      +                "CONCEPT",
      +                "PERSON",
      +                "ORGANIZATION",
      +                "PLACE"
      +              ],
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ],
      +          "default": null,
      +          "title": "Entity Type"
      +        },
      +        "name": {
      +          "title": "Name",
      +          "type": "string"
      +        },
      +        "relationship_type": {
      +          "default": "",
      +          "title": "Relationship Type",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "name"
      +      ],
      +      "title": "RelatedEntity",
      +      "type": "object"
      +    },
      +    "maxItems": 30,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  2. Changed2 schema fields changedv0.1.10
    • addedInput schema / properties / entity_id / description
      Added value: +"From next_synthesis"
    • addedInput schema / properties / input_digest / description
      Added value: +"From next_synthesis"
  3. Changed25 schema fields changedv0.1.5
    • addedInput schema / properties / key_aspects / anyOf
      Added value: +[
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "maxItems": 10,
      +    "minItems": 1,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / key_aspects / default
      Added value: +null
    • removedInput schema / properties / key_aspects / items
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / key_aspects / maxItems
      Removed value: -10
    • removedInput schema / properties / key_aspects / minItems
      Removed value: -1
    • removedInput schema / properties / key_aspects / type
      Removed value: -"array"
    • addedInput schema / properties / related_entities / anyOf
      Added value: +[
      +  {
      +    "items": {
      +      "$ref": "#/$defs/RelatedEntity"
      +    },
      +    "maxItems": 30,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / related_entities / default
      Added value: +null
    • removedInput schema / properties / related_entities / items
      Removed value: -{
      -  "$ref": "#/$defs/RelatedEntity"
      -}
    • removedInput schema / properties / related_entities / maxItems
      Removed value: -30
    • removedInput schema / properties / related_entities / type
      Removed value: -"array"
    • addedInput schema / properties / sections
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Update: only the changed sections, as {heading: full new section text}; an empty text removes a section",
      +  "title": "Sections"
      +}
    • addedInput schema / properties / summary / anyOf
      Added value: +[
      +  {
      +    "maxLength": 800,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / summary / default
      Added value: +null
    • changedInput schema / properties / summary / description
      Previous value: -"2-3 sentence overview"New value: +"2-3 sentence overview; for an update only if it changes"
    • removedInput schema / properties / summary / maxLength
      Removed value: -800
    • removedInput schema / properties / summary / minLength
      Removed value: -1
    • removedInput schema / properties / summary / type
      Removed value: -"string"
    • addedInput schema / properties / synthesis / anyOf
      Added value: +[
      +  {
      +    "maxLength": 20000,
      +    "minLength": 200,
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / synthesis / default
      Added value: +null
    • changedInput schema / properties / synthesis / description
      Previous value: -"Markdown article citing sources as [uid] and linking entities as [[Name]]"New value: +"New page: Markdown with '## ' sections, citing sources as [uid] and linking entities as [[Name]]"
    • removedInput schema / properties / synthesis / maxLength
      Removed value: -20000
    • removedInput schema / properties / synthesis / minLength
      Removed value: -200
    • removedInput schema / properties / synthesis / type
      Removed value: -"string"
    • changedInput schema / required
      Previous value: -[
      -  "entity_id",
      -  "input_digest",
      -  "summary",
      -  "synthesis",
      -  "key_aspects",
      -  "related_entities"
      -]New value: +[
      +  "entity_id",
      +  "input_digest"
      +]
  4. First observedv0.1.1

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, so the safety profile is covered; the description adds that the existing page is replaced and that updates may carry only changed sections, which is real behavioral context. It does not disclose what is lost on replacement (history, links) or the consequence of a mismatched input_digest, and defers the rest to guide("synthesis").

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?

Two sentences, front-loaded with the action and effect, then the mode distinction, then a terse rules pointer. No filler; the guide() reference is terse but purposeful.

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?

With annotations covering safety and an output schema covering returns, the description supplies the essential framing: source tool, replacement semantics, and new-vs-update modes. The remaining gap is the meaning/enforcement of `input_digest` and any preconditions, which the agent must infer.

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

Parameters4/5

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

Schema coverage is 75% and individual fields are well documented, so the baseline is high; the description adds the mode split that tells the agent when to supply `synthesis` (new page) versus `sections` (partial update). It says nothing about `input_digest` semantics or the role of `project`, which the schema handles but only thinly.

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?

Specific verb+resource ('Save an entity page') with the source of the payload ('from next_synthesis') and the effect ('replacing the stored one'), plus a new-page vs partial-update distinction. It clearly points at its predecessor tool, though it does not contrast against nearby entity tools such as merge_entities or find_entities.

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?

'From next_synthesis' and the explicit 'Rules: guide("synthesis")' pointer give a clear call context and a route to obtain the governing rules. It stops short of stating exclusions or failure conditions (e.g., stale input_digest, missing prior synthesis).

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