Skip to main content
Glama

Helvabase — Governed response dossiers

helvabase_record_document_analysis

Idempotent

After actually analyzing a received page against the current analysis, explicitly declare ALL its examined fragment indexes and linked requirement IDs. State why a page contains no requirements, or use needs_review for unresolved material. Receiving a page never records analysis automatically. Source changes/restarts or new analysis invalidate this declaration. This is an attributed model declaration, not proof of comprehension or human approval. Reassemble the dossier after coverage changes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteYes
projectIdYesHelvabase project/mapping ID returned by list or create dossier, never a local path.
sourceKeyYes
conclusionYes
pageRevisionYes
idempotencyKeyYesUnique key for this logical mutation. Reuse exactly the same key and arguments after a timeout; never generate a new key to force a replay.
requirementIdsYes
contextRevisionYes
analysisRevisionYes
examinedFragmentsYes
expectedReadRevisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With readOnlyHint=false and idempotentHint=true already declared, the description still adds non-obvious behavior: the declaration is invalidated by source changes/restarts or new analysis, it is an attributed model declaration rather than proof of comprehension or human approval, and ingestion does not auto-record analysis. These are meaningful traits beyond the annotations, though conflict/failure behavior is not covered.

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?

It is front-loaded with the core action and each sentence carries information. It is dense jargon but mostly earns its length; only the trailing 'reassemble the dossier' line feels loosely attached to the declaration itself.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 11 required params, nested revision objects and no output schema, the description covers intent and invalidation but omits how the revision objects must be sourced and matched, which is the riskiest part of a correct call. Given the complexity, a full contract is still missing.

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 only 18% (2 of 11 params described), so the description must compensate. It adds semantics for examinedFragments, requirementIds, conclusion (needs_review) and note, but leaves sourceKey, pageRevision, contextRevision, analysisRevision and expectedReadRevision unexplained, so the revision/versioning contract stays opaque.

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 states a concrete action: explicitly declaring the examined fragment indexes and linked requirement IDs for a received page after analysis. Verb+resource are discernible ('record document analysis'), but it never contrasts itself with siblings like prepare_document_analysis or submit_analysis, so the agent must infer the boundary.

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?

It gives real when-to-use guidance: declare after actually analyzing a page, explain why a page contains no requirements, or use needs_review for unresolved material. It also notes receiving a page does not record automatically and to reassemble the dossier after coverage changes. No exclusion against alternative tools is named, though.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.