Skip to main content
Glama

preview_source_create

Preview and validate a proposed source file without creating it; review path and content before requesting Owner-approved creation.

Instructions

Review a proposed general source file without creating it.

Use to validate and preview creating a new source file at a permitted path. No file is created; send full proposed content only when safe, then separately seek Owner-approved creation if appropriate.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>",
      "content": "<content>"
    },
    "name": "preview_source_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesProposed new source file path within Owner-configured scope, not yet created.
contentYesFull proposed text; may contain secrets. Avoid submitting secrets; submitted writes require local Owner review. Preview alone never saves.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations, the description carries the full burden, and it does so well: it states twice that nothing is created or saved, and notes that submitted writes require local Owner review and that paths must be within Owner-configured scope. It omits rate limits and what the preview response contains, though an output schema exists to cover the latter.

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?

Two short sentences with the no-side-effect guarantee front-loaded. There is mild redundancy between 'without creating it' and 'No file is created', but nothing is wasted or buried.

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 two-parameter preview tool with a fully described schema and an output schema, the definition covers the essential safety and scoping facts an agent needs. The main missing piece is how this differs from preview_source_patch and create_file, which matters given the dense sibling set.

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 100%, so both parameters are already documented in detail, including the secrets warning on 'content'. The description only adds the caution to send full content 'only when safe', which is marginal value beyond the schema; 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?

The first sentence gives a specific verb and resource ('Review a proposed general source file') plus the key qualifier 'without creating it', which separates it from create_file. It does not explicitly distinguish itself from the sibling preview_source_patch, so the agent must infer the difference between a 'general source file' and a patch.

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 second sentence states when to use it ('to validate and preview creating a new source file at a permitted path') and even outlines the follow-up step ('separately seek Owner-approved creation'). There are no explicit exclusions or named alternatives, which is the only thing keeping this below a 5.

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