Skip to main content
Glama

Describe an app

describe_app
Read-only

Show an app's collections (the kinds of record it holds) with every field's id, label, type and choices, plus its views.

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": "<app>"
    },
    "name": "describe_app"
  }
}

Input Schema

NameRequiredDescriptionDefault
appYesThe app's id, or its name as shown in Bionic Forms

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

readOnlyHint=true is consistent with "Show", and the description goes beyond the annotation by disclosing exactly what the read returns: collections, per-field id/label/type/choices, and views. That is meaningful context given there is no output schema. It omits any note about behavior for an unknown app name/id, which keeps it from a 5.

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?

One tightly packed sentence with zero filler; the resource is front-loaded and the parenthetical gloss on "collections" earns its place by disambiguating an internal term.

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?

With no output schema and only one parameter, the description needs to convey the shape of the response, and it does so concretely down to field-level attributes and views. Only the failure mode for an unresolvable app identifier is left unaddressed.

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% and the single "app" parameter already documents that it accepts an id or a display name, so the schema carries the burden. The description adds no format, resolution-order, or fallback detail beyond that, which is the expected baseline.

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?

"Show an app's collections ... with every field's id, label, type and choices, plus its views" names a specific verb and resource and enumerates the payload, which is clearly distinct from record-oriented siblings like get_record and search_records. It stops short of explicitly naming a sibling to contrast with, so it lands at 4 rather than 5.

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?

There is no explicit statement of when to call this versus list_apps or list_records; the reader must infer that this is the schema-discovery step before writing records. The purpose makes that inference easy, but no alternative or precondition is ever stated.

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