field_get_fieldGet a single field by ID or code
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | UUID value wrapper. | |
| code | No | Lowercase kebab-case code identifier. | |
| companyId | No | UUID value wrapper. |
| Name | Required | Description | Default |
|---|---|---|---|
| field | No |
Changes observed during successful MCP inspections.
Output schema / properties / field / anyOfAdded value: +[
+ {
+ "properties": {
+ "code": {
+ "anyOf": [
+ {
+ "description": "Lowercase kebab-case code identifier.",
+ "properties": {
+ "value": {
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "companyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "createdAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "description": {
+ "anyOf": [
+ {
+ "description": "Free-form description (max 5000 chars).",
+ "properties": {
+ "value": {
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "id": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "metadata": {
+ "anyOf": [
+ {
+ "properties": {
+ "values": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "name": {
+ "anyOf": [
+ {
+ "description": "Human-readable name (1-255 Unicode chars).",
+ "properties": {
+ "value": {
+ "maxLength": 255,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "options": {
+ "items": {
+ "properties": {
+ "code": {
+ "anyOf": [
+ {
+ "description": "Lowercase kebab-case code identifier.",
+ "properties": {
+ "value": {
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "companyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "createdAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "depth": {
+ "type": "integer"
+ },
+ "description": {
+ "anyOf": [
+ {
+ "description": "Free-form description (max 5000 chars).",
+ "properties": {
+ "value": {
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "fieldId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "id": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "metadata": {
+ "anyOf": [
+ {
+ "properties": {
+ "values": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "name": {
+ "anyOf": [
+ {
+ "description": "Human-readable name (1-255 Unicode chars).",
+ "properties": {
+ "value": {
+ "maxLength": 255,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "parentId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "path": {
+ "type": "string"
+ },
+ "sortOrder": {
+ "type": "integer"
+ },
+ "updatedAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "fieldId",
+ "name",
+ "code"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "parentFieldId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "type": {
+ "enum": [
+ "FIELD_TYPE_UNSPECIFIED",
+ "FIELD_TYPE_STRING",
+ "FIELD_TYPE_NUMBER",
+ "FIELD_TYPE_DATE",
+ "FIELD_TYPE_SELECT"
+ ],
+ "type": "string"
+ },
+ "updatedAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "valueMode": {
+ "enum": [
+ "FIELD_VALUE_MODE_UNSPECIFIED",
+ "FIELD_VALUE_MODE_SINGLE",
+ "FIELD_VALUE_MODE_MULTI"
+ ],
+ "type": "string"
+ },
+ "visibility": {
+ "enum": [
+ "FIELD_VISIBILITY_UNSPECIFIED",
+ "FIELD_VISIBILITY_VISIBLE",
+ "FIELD_VISIBILITY_HIDDEN",
+ "FIELD_VISIBILITY_SYSTEM"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "code"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+]Output schema / properties / field / propertiesRemoved value: -{
- "code": {
- "description": "Lowercase kebab-case code identifier.",
- "properties": {
- "value": {
- "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
- "type": "string"
- }
- },
- "type": "object"
- },
- "companyId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "createdAt": {
- "format": "date-time",
- "type": "string"
- },
- "description": {
- "description": "Free-form description (max 5000 chars).",
- "properties": {
- "value": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "type": "object"
- },
- "id": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "metadata": {
- "properties": {
- "values": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "description": "Human-readable name (1-255 Unicode chars).",
- "properties": {
- "value": {
- "maxLength": 255,
- "minLength": 1,
- "type": "string"
- }
- },
- "type": "object"
- },
- "options": {
- "items": {
- "properties": {
- "code": {
- "description": "Lowercase kebab-case code identifier.",
- "properties": {
- "value": {
- "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
- "type": "string"
- }
- },
- "type": "object"
- },
- "companyId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "createdAt": {
- "format": "date-time",
- "type": "string"
- },
- "depth": {
- "type": "integer"
- },
- "description": {
- "description": "Free-form description (max 5000 chars).",
- "properties": {
- "value": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "type": "object"
- },
- "fieldId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "id": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "metadata": {
- "properties": {
- "values": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "description": "Human-readable name (1-255 Unicode chars).",
- "properties": {
- "value": {
- "maxLength": 255,
- "minLength": 1,
- "type": "string"
- }
- },
- "type": "object"
- },
- "parentId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "path": {
- "type": "string"
- },
- "sortOrder": {
- "type": "integer"
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string"
- }
- },
- "required": [
- "fieldId",
- "name",
- "code"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "parentFieldId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": {
- "enum": [
- "FIELD_TYPE_UNSPECIFIED",
- "FIELD_TYPE_STRING",
- "FIELD_TYPE_NUMBER",
- "FIELD_TYPE_DATE",
- "FIELD_TYPE_SELECT"
- ],
- "type": "string"
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string"
- },
- "valueMode": {
- "enum": [
- "FIELD_VALUE_MODE_UNSPECIFIED",
- "FIELD_VALUE_MODE_SINGLE",
- "FIELD_VALUE_MODE_MULTI"
- ],
- "type": "string"
- },
- "visibility": {
- "enum": [
- "FIELD_VISIBILITY_UNSPECIFIED",
- "FIELD_VISIBILITY_VISIBLE",
- "FIELD_VISIBILITY_HIDDEN",
- "FIELD_VISIBILITY_SYSTEM"
- ],
- "type": "string"
- }
-}Output schema / properties / field / requiredRemoved value: -[
- "name",
- "code"
-]Output schema / properties / field / typeRemoved value: -"object"Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is clear. The description adds the detail that the field can be retrieved by ID or code, but doesn't describe the return structure, potential errors, or any other behavioral nuances. Given the annotations cover the read-only nature, this is adequate but not enriching.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, succinct sentence: 'Get a single field by ID or code'. It is front-loaded with the action and subject, and contains zero fluff. Every word contributes to the meaning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is a simple read operation with an output schema present, so the description doesn't need to explain the return format. However, it omits any context about the optional companyId parameter, which might be needed for scoping in multi-tenant environments. The lack of guidance on when to use ID vs code is also a minor gap. Overall, it's sufficient for a straightforward getter but not fully complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema provides descriptions for each parameter: id and companyId are UUID wrappers, code is a kebab-case identifier. The description adds the key information that the field can be fetched by either ID or code, clarifying the mutual exclusivity. However, it doesn't explain the role of companyId (e.g., whether it scopes the lookup). With 100% schema coverage, this is a baseline 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Get' and the resource 'a single field', and specifies the two lookup methods: 'by ID or code'. This distinguishes it from sibling field_get_list_fields (which lists fields) and field_get_field_option (which gets a specific option). The purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit guidance on when to use this tool versus the alternatives (e.g., field_get_list_fields for listing, or field_get_field_option for options). The description implies a single-field lookup, but doesn't state when to prefer it, nor does it explain the relationship between ID and code or when one should be used over the other.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.