Skip to main content
Glama
anggasct

MCP-Insomnia

by anggasct

preview_sync_to_insomnia

Preview syncing a collection to Insomnia by classifying documents as toCreate, toUpdate, or toDelete against the target. Performs no writes.

Instructions

Preview the effect of syncing a collection to Insomnia: classify documents into toCreate/toUpdate/toDelete vs the Insomnia target. Performs no writes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdNoInsomnia project ID (optional, defaults to first project)
collectionIdYesMCP collection ID to preview

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.8.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explicitly states 'Performs no writes,' which is the critical behavioral trait for a preview/dry-run tool, and it explains what kind of classification output the agent can expect. It does not address edge cases like missing collections or auth, but the main behavioral contract is clear.

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 with no redundancy. The core purpose is front-loaded, the classification behavior is stated explicitly, and the no-writes guarantee is included as a separate concise sentence.

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 tool is low complexity, both parameters are fully documented in the schema, and the output categories (toCreate/toUpdate/toDelete) are described even though no output schema exists. The only minor gap is that the description does not elaborate on how the Insomnia target is selected beyond the schema's projectId note, but this is not material.

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%, with both projectId and collectionId already fully documented in the schema, so the baseline is 3. The description adds 'collection to Insomnia' context and the preview semantics, but adds no parameter-specific meaning beyond the schema.

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 names a specific verb ('preview'), a specific resource ('syncing a collection to Insomnia'), and a concrete behavior (classifying documents into toCreate/toUpdate/toDelete). It clearly differentiates itself from the sibling sync_to_insomnia by emphasizing that it performs no writes.

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 conveys strong contextual guidance: this is a safe, non-mutating preview of what a sync would do, implying it should be used before actually syncing. It does not explicitly name alternatives or state exclusion conditions, but the 'performs no writes' framing makes the intended use clear.

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