Skip to main content
Glama
mkyrpychnyk

cherwell-mcp

by mkyrpychnyk

get_business_object

Retrieve a single Cherwell business object record by its internal or public ID, returning all field values.

Instructions

Read a single business object record with all its field values, addressed by record ID (busObRecId) or public ID (e.g. incident number). Provide exactly one of recId / publicId.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
recIdNoInternal record ID (busObRecId) of the record.
publicIdNoPublic ID of the record (e.g. incident number).
businessObjectYesBusiness object name (e.g. "Incident") or its 32-character busObId.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It implies a safe read and discloses that all field values are returned, which is useful, but says nothing about permissions, behavior when the ID is invalid, or record-not-found handling.

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?

A single tight sentence that leads with the verb and resource, then the addressing options, then the exclusivity constraint. No 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?

For a simple single-record read with no output schema, the description tells the agent what it gets back (all field values) and how to address the record. Adequate; only failure/permission behavior is unaddressed.

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 coverage is 100%, so the baseline is 3, and the description adds the mutual-exclusivity rule ('exactly one of recId / publicId') that the schema does not encode as oneOf/anyOf. That is genuine added meaning beyond the structured fields.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Read) plus resource (a single business object record) and the addressing schemes (busObRecId or public ID). The singular 'single record / addressed by ID' framing contrasts implicitly with list_business_object_summaries and search_business_objects, though no sibling is named explicitly.

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

Usage Guidelines3/5

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

Usage is implied (fetch one record when you already have its ID) but never contrasted with siblings like search_business_objects or list_business_object_summaries. The one explicit rule — 'Provide exactly one of recId / publicId' — is a parameter constraint rather than a when-to-use statement.

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