Skip to main content
Glama
soil-dev

capsulemcp

by soil-dev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_custom_field

Read-only

Retrieve a specific custom field definition by its id to view field details and configuration. Use list_custom_fields first to find the id.

Instructions

Show a single custom field DEFINITION by id. Use list_custom_fields first to discover field ids.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesCustom field definition id.
entityYesWhich entity type's custom field schema to inspect.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.3.0
    • changedInput schema / required
      Previous value: -[
-  "entity"
-]New value: +[
+  "entity",
+  "id"
+]
  2. Changed4 schema fields changedv2.1.2
    • changedInput schema / properties / entity / description
      Previous value: -"Which entity type's custom field schema to inspect. Use 'kases' for projects."New value: +"Which entity type's custom field schema to inspect."
    • changedInput schema / properties / entity / enum
      Previous value: -[
-  "parties",
-  "opportunities",
-  "kases"
-]New value: +[
+  "parties",
+  "opportunities",
+  "projects"
+]
    • removedInput schema / properties / fieldId
      Removed value: -{
-  "description": "Custom field definition id.",
-  "exclusiveMinimum": 0,
-  "maximum": 9007199254740991,
-  "type": "integer"
-}
    • addedInput schema / properties / id
      Added value: +{
+  "description": "Custom field definition id.",
+  "exclusiveMinimum": 0,
+  "maximum": 9007199254740991,
+  "type": "integer"
+}
  3. Addedv1.7.0
  4. Removedv1.6.2
  5. First observedv1.0.0

TDQS

A4.3/5.0
Behavior3/5

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 established. The description adds that this returns a definition rather than a value, but it does not disclose behavior like not-found responses or authorization requirements. Given the annotations cover the main behavioral concerns, a neutral score is appropriate.

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?

Two short sentences with no filler. The primary action and object are front-loaded, and the discovery instruction is placed second. Every word earns its place.

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?

For a low-complexity read-only tool with two fully documented parameters, the description is complete. It states what the tool does, how to get the required id, and the annotations cover side-effect safety. No output schema exists, but the return value is implied by 'show' and the definition focus.

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

Parameters3/5

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

Schema description coverage is 100%, with both id and entity already described in the input schema. The description only repeats the notion of field ids and adds no new parameter semantics. Baseline 3 is appropriate when the schema fully documents parameters.

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 the action: show a single custom field definition by id. It explicitly uses 'single' and 'by id', which distinguishes it from listing tools. The uppercase 'DEFINITION' reinforces that this returns the field metadata, not values.

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

Usage Guidelines5/5

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

The description explicitly instructs to use list_custom_fields first to discover field ids, providing a clear precondition and workflow. This effectively differentiates the tool from its sibling list_custom_fields and tells an agent when to call it.

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