Skip to main content
Glama
ProofHoldings

@proof-holdings/mcp-server

Official
by ProofHoldings
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

preview_template

Read-only

Preview a message template with sample data before saving to see how placeholder variables render for a specific channel and sub-account.

Instructions

Preview a template with sample data before saving, as a sub-account (project) would send it. Shows how the message will look with placeholder variables filled in.

ACCESS: needs a Proof account. Set PROOF_API_KEY and restart this server, then call this tool again. start_login does NOT open this tool.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesTemplate body text
channelYesMessage channel
subjectNoEmail subject line
profile_idNoThe sub-account (project) to act on; omitted → your key's project, or the primary project for an account-wide key
button_textNoButton text
message_typeYesMessage type
button_url_templateNoButton URL template

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.7.0
    • addedInput schema / properties / profile_id
      Added value: +{
+  "description": "The sub-account (project) to act on; omitted → your key's project, or the primary project for an account-wide key",
+  "pattern": "^[0-9a-fA-F]{24}$",
+  "type": "string"
+}
  2. First observedv1.1.0

TDQS

A3.7/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, but the description adds real context beyond annotations: it requires a Proof account, needs PROOF_API_KEY set with a server restart, and explicitly warns that start_login does NOT unlock this tool. It also discloses that placeholder variables get filled in, which tells the agent what the preview actually contains.

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?

Purpose is front-loaded in the first sentence, with the access caveat isolated in a second block so it is easy to scan. Only minor redundancy ("Shows how the message will look" largely restates "preview with sample data").

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 read-only preview tool with full schema coverage and no output schema, the description covers what it does, the pre-save timing, and the account/key prerequisite. Missing only return-content detail, which is largely excused by the absence of an output schema.

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 every parameter including channel, message_type enums and profile_id is already documented in the schema. The description adds only the notion that output is rendered as a sub-account would send it, which loosely relates to profile_id but adds no syntax or format detail beyond the schema.

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+resource ("Preview a template with sample data") and adds scope ("as a sub-account (project) would send it", "before saving"). It broadly distinguishes itself from render_template via the pre-save preview framing, but never names the sibling that a confused agent would most likely reach for.

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?

"before saving" implies the use window (prior to update_template), and the access note gives a hard prerequisite. However, no alternative tool is named and no explicit when-not guidance is offered, leaving the agent to infer whether render_template or get_template is the better fit.

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

Deploy Server

Other Tools