Skip to main content
Glama

List custom field definitions

list_custom_field_definitions
Read-onlyIdempotent

List custom field definitions configured for this tenant. Filter by entity type (e.g. asset, work_order) or field type.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default: all pages fetched automatically)
per_pageNoItems per page (default: 1000, max: 1000). All pages are fetched automatically.
field_typeNoFilter by field type
entity_typeNoFilter by entity type (e.g. asset, work_order)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / page / maximum
      Added value: +9007199254740991
  2. Changed3 schema fields changed
    • changedInput schema / $schema
      Previous value: -"https://json-schema.org/draft/2020-12/schema"New value: +"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / page / maximum
      Removed value: -9007199254740991
  3. Changed3 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / page / maximum
      Added value: +9007199254740991
  4. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered structurally. The description only adds the tenant-scoping constraint; it says nothing about pagination behavior or result shape, which the schema partly covers instead.

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?

Two tight sentences with the resource and scope front-loaded and the filter options second; no filler or redundant restatement of the tool name.

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 simple read-only list tool with no required parameters, no output schema and full annotation coverage, the description covers what the tool returns at a conceptual level and how to narrow results. Only the behaviors already handled by annotations and the pagination schema are omitted.

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% and each parameter (page, per_page, field_type, entity_type) is already documented, including the enum for field_type. The description's mention of entity/field type filters with examples (asset, work_order) largely restates the entity_type schema text, so it adds little beyond the 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?

States a specific verb and resource ("List custom field definitions") and adds tenant scope plus the two filterable facets. It does not name the nearby siblings (get_custom_field_definition, list_custom_field_values), so an agent must infer the boundary itself, but the purpose is unambiguous.

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?

Filtering is described ("Filter by entity type ... or field type"), which implies when the tool is useful, but there is no explicit when-to-use/when-not guidance and no mention of alternatives such as get_custom_field_definition for a single definition or list_custom_field_values for values.

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