Skip to main content
Glama
YogiAdhik

civicrm-mcp

by YogiAdhik

Describe field options

civicrm_describe_field_options

Retrieve the valid option values for a specific field in a CiviCRM entity, such as activity types or contribution statuses, without loading the entire entity.

Instructions

Return the option list (pseudoconstant values) for a single field on an entity. Far cheaper than civicrm_describe_entity when you only need to know the valid values for one enum-like field — e.g. 'what are the legal activity_type values'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldYesField name whose option list you want, e.g. 'activity_type_id', 'financial_type_id', 'contribution_status_id', 'contact_type'.
entityYesAPIv4 entity name, e.g. Activity, Contribution, Contact, Membership.
Behavior2/5

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

No annotations provided, so description carries full burden. It does not disclose behavioral traits such as error handling, performance characteristics (beyond 'far cheaper'), auth requirements, or output format. Minimal behavioral context beyond basic function.

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: first states core purpose, second provides context and comparison. No redundant words. Front-loaded with key action and resource.

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 tool with 2 params and no output schema, the description covers purpose, usage context, and example. However, it lacks details on return format and error conditions, which would enhance completeness.

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

Parameters4/5

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

Schema coverage is 100%, baseline 3. Description adds value by explaining the concept of 'option list (pseudoconstant values)' and giving example field values like 'activity_type_id'. This reinforces the schema descriptions but doesn't add substantial new information.

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 it returns option list for a single field on an entity, using specific verb 'return' and resource 'option list for a single field'. It distinguishes itself from sibling 'civicrm_describe_entity' by noting it's cheaper and focused.

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 tells when to use: 'when you only need to know the valid values for one enum-like field'. Provides alternative 'civicrm_describe_entity' and notes it's cheaper. Example given further clarifies usage.

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/YogiAdhik/civicrm-mcp'

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