Skip to main content
Glama

preview_proposal

Read-only

Show what a proposal would contain for a record — title, customer, price, pricing lines and tiers — without creating it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tiersNoOffer only these option tiers (ids from list_proposal_templates); default all
templateYesTemplate id (pdf_group_id) or title, from list_proposal_templates
argumentsNoThe template's arguments, e.g. {job_id: 42} — plain values only

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds the dry-run framing ('without creating it') and lists the fields the preview returns, which is meaningful since no output schema exists, but it discloses nothing about auth, limits, or error behavior.

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?

A single sentence, front-loaded with the verb and resource, with no wasted words. The dash-separated enumeration is compact and skimmable.

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?

Because there is no output schema, enumerating the returned content (title, customer, price, pricing lines, tiers) compensates well. The one gap is not clarifying how 'arguments' plain values map into the preview, but the schema covers that case.

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%, so template, tiers, and arguments are all documented in the schema itself. The description adds no parameter meaning beyond what the schema already provides; the baseline 3 applies.

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?

States a specific verb (show/preview) and resource (proposal), and enumerates the content it previews (title, customer, price, pricing lines, tiers). The phrase 'without creating it' clearly separates it from a create/generate operation, though it never names an actual sibling tool.

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 'without creating it' phrasing implies this is a dry-run/preview step to use before creating a proposal, which is useful context. However, it gives no explicit when-to-use guidance relative to neighbors like list_proposals, list_proposal_templates, or generate_document, so the agent must infer.

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.