Skip to main content
Glama

List contact fields and pipeline stages

list_contact_fields
Read-onlyIdempotent

Return the custom attributes defined on this site's contacts (key, label, type, select options) AND the pipeline stage keys status will accept. Call this BEFORE upsert_contacts when importing: it tells you which custom-field keys already exist, so you map a spreadsheet onto the site's own vocabulary instead of inventing a second key for something it already tracks.

Input Schema

NameRequiredDescriptionDefault
site_idYesThe site to inspect
user_goalNoOptional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / user_goal
      Added value: +{
      +  "description": "Optional: the user's goal behind this call, in one short sentence of plain words (e.g. \"add a page so customers can book tables\"). No names, emails or other personal details.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so safety is covered structurally. The description adds genuine value by enumerating what the response contains and framing the call as a pre-flight discovery step. Minor gap: no note on size/volume of the returned field list for large sites.

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 sentences, front-loaded with the return contract before the call-to-action guidance. No filler; the uppercase 'AND' efficiently flags that two distinct vocabularies come back.

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?

For a two-parameter read-only tool with no output schema, the description compensates by describing the returned fields and pipeline stage keys explicitly, plus the downstream workflow it feeds. Nothing an agent needs to invoke it correctly is missing.

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% for both `site_id` and `user_goal`, so the schema already carries the semantics. The description adds nothing about either parameter (e.g. that `site_id` scopes the vocabulary returned), so baseline 3 applies.

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?

States a specific verb and resource plus the exact payload: custom attribute keys, labels, types, select options, and the pipeline stage keys `status` accepts. This distinguishes it from `define_contact_field` (which creates) and `list_contact_filter_vocabulary` (which lists filter terms, not field definitions).

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?

Explicitly says 'Call this BEFORE upsert_contacts when importing' and gives the reason (map a spreadsheet onto the site's existing vocabulary rather than inventing duplicate keys). The alternative tool and the condition selecting this one are both named.

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