Skip to main content
Glama

fields_get_field

Retrieve detailed field definition for a given entity type and field ID, including validation rules, options, metadata, and flags.

Instructions

Get details of a specific field by ID and entity type.

Retrieves complete information about a single field definition, including all validation rules, options, and metadata.

Response includes:

  • Field ID, key, and name

  • Field type and validation rules

  • Options for enum fields

  • Flags: mandatory, editable, searchable, filterable, sortable, bulk_edit_allowed

Cached for 15 minutes as field definitions rarely change.

Common use cases:

  • Get specific field details: { "entity_type": "deal", "field_id": 12345 }

  • Check field validation rules before updating

  • Retrieve enum options for a dropdown field

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_typeYesType of entity (deal, person, organization, activity, product)
field_idYesField ID to retrieve
Behavior4/5

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

No annotations are provided, so the description carries full burden. It discloses caching behavior ('Cached for 15 minutes') and lists the response fields, giving transparency about output. It does not mention rate limits or error handling, but for a read-only lookup, this is adequate.

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?

The description is concise and well-structured: a brief summary, response fields in bullet points, caching note, and common use cases. Every sentence serves a purpose with no redundancy.

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?

The description covers purpose, parameters, response structure, and caching behavior. Given no output schema and simple parameters, it provides sufficient context for an agent to invoke the tool correctly.

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 has 100% coverage, describing both parameters. The description adds value by showing a concrete example and explaining the context of parameters (entity types listed, field ID as identifier).

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 'Get details of a specific field by ID and entity type.' This distinguishes it from sibling tools that list fields (e.g., fields_list_deal_fields) by focusing on a single field retrieval.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides common use cases and an example, implicitly indicating when to use this tool: when you have a specific field ID. However, it does not explicitly exclude alternative tools or state when not to use it.

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/iamsamuelfraga/mcp-pipedrive'

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