Skip to main content
Glama

update_schema_incremental

Add new fields to a schema or remove existing ones while preserving historical data. Creates and activates a new schema version immediately for new data storage, with optional migration of existing data to maintain consistency.

Instructions

Incrementally update a schema by adding new fields from raw_fragments or agent recommendations. Creates new schema version and activates it immediately, so all new data stored after this call will use the updated schema. Optionally migrates existing raw_fragments to observations for historical data backfill.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_typeYesEntity type to update
fields_to_addNoFields to add to schema
fields_to_removeNoField names to remove from schema (triggers major version bump). Observation data is preserved; fields can be restored by re-adding them later.
schema_versionNoNew schema version (auto-increments if not provided)
user_specificNoCreate user-specific schema variant (default: false)
user_idNoUser ID for user-specific schema (required if user_specific=true)
activateNoActivate schema immediately so it applies to new data (default: true). If false, schema is registered but not active.
migrate_existingNoMigrate existing raw_fragments to observations for historical data backfill (default: false). Note: New data automatically uses updated schema after activation, migration is only for old data.
Behavior4/5

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

With no annotations provided, the description carries full burden and does an excellent job disclosing behavioral traits. It explains the versioning behavior ('creates new schema version'), activation timing ('activates it immediately'), data impact ('all new data stored after this call will use the updated schema'), and migration options ('optionally migrates existing raw_fragments'). It doesn't mention permissions, rate limits, or error conditions, but provides substantial operational context.

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 perfectly sized at three sentences, each earning its place. The first sentence establishes purpose, the second explains the immediate activation consequence, and the third covers optional migration. No wasted words, and the most critical information (schema update and activation) appears first.

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 complex schema mutation tool with 8 parameters and no annotations or output schema, the description provides substantial context about behavior and consequences. It explains versioning, activation timing, and migration options. However, it doesn't mention what happens to existing data (beyond migration), error conditions, or return values, leaving some gaps for a tool of this complexity.

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?

With 100% schema description coverage, the schema already documents all 8 parameters thoroughly. The description adds some context about the overall purpose ('adding new fields') and migration behavior, but doesn't provide additional parameter-specific semantics beyond what's in the schema descriptions. This meets the baseline expectation when schema coverage is complete.

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?

The description clearly states the specific action ('incrementally update a schema'), the mechanism ('adding new fields from raw_fragments or agent recommendations'), and the immediate effect ('creates new schema version and activates it immediately'). It distinguishes itself from siblings like 'register_schema' by focusing on incremental updates rather than initial registration.

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?

The description provides clear context about when to use this tool ('to add new fields' and 'optionally migrates existing raw_fragments for historical data backfill'), but doesn't explicitly state when NOT to use it or mention alternatives like 'register_schema' for initial schema creation. It does differentiate from sibling tools by its incremental nature.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/markmhendrickson/neotoma'

If you have feedback or need assistance with the MCP directory API, please join our Discord server