Skip to main content
Glama
benmonopoli

Greenhouse MCP

by benmonopoli
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

update_custom_field

Update a custom field's name, privacy, or helper text. Admin-only write operation; find IDs with list_custom_fields.

Instructions

Update a custom field's name, privacy or description. Write operation — admin only.

To find custom_field_id: list_custom_fields → match by name. Renaming does not change the field's name_key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoNew display name
privateNoNew privacy setting
descriptionNoNew helper text
custom_field_idYesCustom field ID — get from list_custom_fields

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.5.0
    • addedInput schema / properties / custom_field_id / description
      Added value: +"Custom field ID — get from list_custom_fields"
    • addedInput schema / properties / description
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "New helper text",
+  "title": "Description"
+}
    • addedInput schema / properties / name / description
      Added value: +"New display name"
    • addedInput schema / properties / private / description
      Added value: +"New privacy setting"
  2. Addedv0.3.4

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations present the description must carry the full burden, and it does disclose the two facts that matter most for a mutation: it is a write operation and it requires admin rights. It also notes the non-obvious invariant that renaming leaves name_key unchanged. It omits partial-update/merge semantics for the nullable params, which keeps it from a 5.

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?

Three short sentences, front-loaded with the action and the field list, then the hard constraints and the ID-lookup hint. Nothing is repeated from the schema and no sentence is filler.

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?

An output schema exists, so return values need no explanation, and the description covers the mutation type, auth requirement and ID provenance needed to invoke it correctly. The only gap is unstated behavior for omitted/null arguments versus explicit clears, minor for an update tool.

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 description coverage is 100%, so baseline is 3; the description adds value beyond the schema by naming the three mutable attributes in line with the params and by documenting how to source the required custom_field_id. It still says nothing about what a null/omitted value does, so it does not fully compensate the remaining semantic gap.

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?

Specific verb+resource ("Update a custom field") followed immediately by the exact fields it can modify ("name, privacy or description"), which cleanly separates it from create_custom_field, delete_custom_field and update_custom_field_options. An agent can identify the right tool without opening a schema.

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?

Gives the prerequisite workflow for obtaining the required parameter ("list_custom_fields → match by name") and the permission gate ("admin only"). It does not explicitly say when NOT to use it (e.g. use update_custom_field_options to touch the selectable values), so it stays just short of a full routing rule.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools