Skip to main content
Glama

fields_list_deal_fields

Retrieve all field definitions for deals, including custom fields, to discover field keys, types, validation rules, and dropdown options before creating or updating deals.

Instructions

Get all field definitions for deals, including custom fields.

Use this to discover what fields are available before creating or updating deals. Returns field keys, types, validation rules, and whether fields are required.

Response includes:

  • Field ID and key (use key in API requests)

  • Field name and type (varchar, text, enum, date, monetary, etc.)

  • Validation info (mandatory, editable, searchable)

  • Options for enum/dropdown fields

  • Filtering and sorting capabilities

Cached for 15 minutes as field definitions rarely change.

Common use cases:

  • Discover custom fields before creating deals

  • Check field types and validation rules

  • Find field keys for API requests

  • Understand available enum options

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

With no annotations, description fully discloses behavior: returns field definitions with structure, caching for 15 minutes, no side effects. Also mentions filtering/sorting capabilities.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured with bullet points and clear sections. Front-loads purpose. Slightly verbose but every sentence adds value.

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?

Complete for a parameterless tool: details output structure, caching, and use cases without needing output schema.

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

Parameters5/5

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

Tool has zero parameters. Description correctly adds no parameter info beyond schema. Schema coverage is 100% and no param explanation needed.

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?

Description clearly states 'Get all field definitions for deals' with specific verb and resource. It distinguishes from sibling tools like fields_list_activity_fields by specifying 'for deals' and including custom fields.

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?

Provides explicit use cases: discover fields before creating/updating deals, check types, find keys, understand enum options. Lacks explicit when-not-to-use but context implies usage before mutations.

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