Search custom field definitions MCP tool
Searches the workspace's pursuit custom field definitions and returns each field's ID, name, type (text, number, date, or dollar), and whether it is required. Use the returned IDs as custom_field_id when reading or writing a pursuit's custom_fields.
- MCP tool name:
Search_Custom_Field_Definitions - Data type: Custom field definition data type
- Returns: Custom field definition MCP response
- Search modes: Keyword
- Annotations: Read only, not destructive, idempotent, closed world
- Surfaces: GovTribe AI, GovTribe MCP, GovTribe Compact MCP server (through Invoke Search Tool)
Examples
Use this tool to find the custom_field_id values your workspace uses for pursuit custom fields before reading them from a pursuit or writing them with Create pursuit or Update pursuit. Custom fields store one of four value types: text, number, date, or dollar.
List every custom field the workspace tracks on pursuits
{
"tool": "Search_Custom_Field_Definitions",
"arguments": {
"sort": {
"key": "alphabeticalSort",
"direction": "asc"
},
"fields_to_return": [
"govtribe_id",
"name",
"field_type",
"required",
"placeholder_text"
]
}
}Find the dollar and number fields for a pricing update
{
"tool": "Search_Custom_Field_Definitions",
"arguments": {
"field_types": [
"dollar",
"number"
],
"fields_to_return": [
"govtribe_id",
"name",
"field_type"
]
}
}Which custom fields are required when a pursuit is edited?
{
"tool": "Search_Custom_Field_Definitions",
"arguments": {
"required": true,
"fields_to_return": [
"govtribe_id",
"name",
"field_type"
]
}
}Resolve a definition by name
{
"tool": "Search_Custom_Field_Definitions",
"arguments": {
"query": "bid decision",
"fields_to_return": [
"govtribe_id",
"name",
"field_type"
]
}
}Related articles
- Custom field definition MCP response: Review the response shape returned by this tool.
- Custom field definition data type: Understand the shared record fields and relationships used by this tool.
- Choose a search mode and write queries: Choose keyword or semantic search behavior and shape
queryvalues. - GovTribe AI: Review the GovTribe AI surface where this tool can be called.
- GovTribe for Agents: Use GovTribe for Agents as the starting point for MCP tools, MCP tool responses, and guides.
- MCP servers: Review where this MCP tool can be used.
- Invoke Search Tool MCP tool: Review where this MCP tool can be used.
- Source identifiers and record matching: Use GovTribe IDs and source identifiers when passing records between tools.