Skip to main content
Glama

export_records

Export a form's records to XLSX or PDF and send them by email.

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": {
      "app_id": "<app_id>",
      "entity_id": "<entity_id>"
    },
    "name": "export_records"
  }
}

Input Schema

NameRequiredDescriptionDefault
emailNoRecipient's email (default — the current user)
app_idYesProject ID (from list_projects)
formatNoxlsx (default) or pdf
entity_idYesForm ID (from list_forms or describe_project)
report_idNoReport/filter ID for a selective export

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / email / description
      Previous value: -"Email отримувача (за замовчуванням — поточний юзер)"New value: +"Recipient's email (default — the current user)"
    • changedInput schema / properties / format / description
      Previous value: -"xlsx (default) або pdf"New value: +"xlsx (default) or pdf"
    • changedInput schema / properties / report_id / description
      Previous value: -"ID звіту/фільтру для вибіркового експорту"New value: +"Report/filter ID for a selective export"
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, and destructiveHint=false. The description adds useful context that email delivery occurs, which explains the external side effect, but it does not discuss permissions, delivery behavior, or whether repeated calls resend email.

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?

It is a single, front-loaded sentence with no wasted language. It states the core action, formats, and delivery method efficiently.

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

Completeness3/5

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

The description covers the main action and delivery mode, and the schema details parameters. Because there is no output schema, it is a gap that the description does not explain what the tool returns or whether export/email delivery is synchronous or asynchronous.

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 all five parameters are already documented in the schema. The description reinforces format and email delivery but does not add syntax, defaults, or constraints 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?

The description uses a specific verb and resource: export a form's records to XLSX or PDF and email them. It is clearly distinct from read/list siblings like get_records and search_records, but it does not explicitly name alternatives or scope boundaries.

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?

Usage is implied by the export-and-email action, so an agent can infer it should be used when a user wants form records delivered as a file. However, there is no explicit guidance on when to choose this over get_records, search_records, or report-based retrieval.

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.

Resources