Skip to main content
Glama

list_template_targets

List every editable target in a template—paragraphs, runs, cells, tables, images—with IDs and character constraints to construct accurate edit lists before filling and saving.

Instructions

List every editable target in the template (paragraphs, runs, cells, tables, images) so the chatbot can build a precise edit list.

USE WHEN: Canonical first call before fill_and_save. You need target_ids

  • text_hashes to construct edits, and char_count / display_width / max_recommended_chars to keep generated content within container limits. DO NOT USE WHEN: You only need a human-readable overview — use inspect_template instead.

Provide the template either as template_path or as template_b64 + template_filename. Filter with target_kinds (any subset of {paragraph, run, cell, table, image}); leave None for all kinds. Paginate via start + limit; next_start is non-None when more targets remain. (max_targets is a deprecated alias for limit.)

Each target carries (where applicable):

  • target_id, target_kind, current_text, text_hash

  • char_count (code points), display_width (EAW-aware), max_recommended_chars

  • page_number

  • parent_paragraph_id / parent_table_id — the container

  • row_index / column_index / rowspan / colspan — for cells

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
template_pathNo
template_b64No
template_filenameNo
target_kindsNo
startNo
limitNo
max_targetsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

No annotations exist, so description must carry behavioral info fully. It describes pagination, filtering, deprecated parameters, and returned fields. It is non-destructive but doesn't explicitly state read-only nature; still, transparency is high.

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?

Well-structured with sections, front-loaded purpose, and concise sentences. Slightly verbose in listing returned fields but each line adds value.

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

Completeness5/5

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

Given the presence of an output schema (not shown), the description covers all necessary context: usage scenario, parameter details, pagination behavior, and returned fields. Complete and actionable.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, but the description adds rich semantics: explains alternative ways to provide template (path vs b64+filename), allowable target kinds, pagination start/limit with note on next_start, and deprecation alias for limit. Greatly aids correct invocation.

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 lists editable targets in a template for building an edit list, distinguishing it from siblings like inspect_template (human-readable overview) and fill_and_save (later step).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit 'USE WHEN' and 'DO NOT USE WHEN' conditions are given, directing to use as first call before fill_and_save and to avoid if a human-readable overview suffices, recommending inspect_template instead.

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/jaykim429/report-mcp'

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