Skip to main content
Glama

Inspect Template Structure

inspect_template_structure

Inspect a template document to review its native structure, tags, and identify potential fallback risks before instantiation.

Instructions

Inspect a template doc's native structure, tags, and fallback risk before instantiation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceIdNo
templateDocIdYesThe template doc to inspect.
Behavior3/5

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

No annotations are provided, so the description carries full burden. The word 'inspect' implies a read-only operation, and the description lists what is inspected. However, it does not explicitly state that the tool is non-destructive or mention any permissions or side effects. The transparency is adequate but not detailed.

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?

A single, front-loaded sentence that conveys the essential information without any extraneous words. Every part of the description serves a purpose.

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

Completeness2/5

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

The description does not mention the return value or output format, and with no output schema, the agent is left guessing what information is provided. Given the tool's complexity and lack of annotations, a more complete description would specify the type of result (e.g., a report, list of issues).

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?

The schema has 50% description coverage (templateDocId has description but workspaceId does not). The description adds context about inspecting structure, tags, and fallback risk, which clarifies the purpose of templateDocId but does not address workspaceId. This partially compensates for the schema gaps, but not fully.

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 clearly states the tool inspects a template doc's native structure, tags, and fallback risk before instantiation. It uses a specific verb 'inspect' and resource 'template doc', distinguishing it from siblings like 'create_doc_from_template' and 'analyze_doc_fidelity'.

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 phrase 'before instantiation' provides clear context for when to use this tool. It implies checking a template prior to creating a document, though it does not explicitly state when not to use it or mention specific sibling alternatives like 'analyze_doc_fidelity'.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/DAWNCR0W/affine-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server