Skip to main content
Glama

Update an opportunity

current_rms_update_opportunity
Destructive

Update header fields on an existing opportunity — subject, customer, venue, dates, reference, instructions, tags, custom fields. Only the fields you pass are sent. State changes (convert to quote/order, cancel, mark lost) are deliberately not available. Current RMS: PUT /opportunities/{id}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ratingNoRating, 0-5.
ends_atNoOverall end / collection date-time (UTC).
subjectNoThe opportunity's subject (title).
owned_byNoUser member id of the owner.
store_idNoMove the job to another store.
tag_listNoTags.
venue_idNoThe Venue member id.
member_idNoThe customer (Organisation/Contact member) id.
referenceNoCustomer reference, e.g. their PO number.
starts_atNoOverall start / delivery date-time (UTC).
project_idNoThe project this opportunity belongs to.
descriptionNoInternal description.
custom_fieldsNoCustom field values by field name.
charge_ends_atNoCharging period end (UTC).
opportunity_idYesThe opportunity id.
charge_starts_atNoCharging period start (UTC).
billing_address_idNoThe member's address id used for billing.
customer_returningNoThe customer returns the goods themselves.
customer_collectingNoThe customer collects the goods themselves.
external_descriptionNoDescription shown on customer documents.
delivery_instructionsNoDelivery instructions.
collection_instructionsNoCollection instructions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations declare destructiveHint=true, and the description adds meaningful behavioral context beyond that: partial-update semantics and the exclusion of state transitions (which would otherwise be the most likely accidental mutation). It still doesn't state permission requirements or whether updates are reversible, keeping it short of 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 compact sentences: purpose with field list, then the partial-update rule, then the exclusion rule plus API reference. Each sentence carries distinct information and the most important constraint (patch semantics) is front-loaded.

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 22-parameter mutation tool with no output schema, the description covers purpose, patch behavior, and exclusions well. It is missing validation/permission notes and a pointer to where state changes are performed, which would complete the picture, but an agent has enough to invoke it correctly.

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%, so the baseline is 3. The description groups parameters by domain (subject, customer, venue, dates, reference, instructions, tags, custom fields), which is mildly helpful for orientation but adds no syntax, format, or edge-case detail beyond the schema.

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?

States a specific verb (update) and resource (opportunity header fields) and enumerates exactly which fields are editable: subject, customer, venue, dates, reference, instructions, tags, custom fields. It also explicitly distinguishes scope from state changes and maps to the underlying API operation (PUT /opportunities/{id}). An agent can immediately distinguish this from current_rms_create_opportunity or current_rms_get_opportunity.

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?

Explicitly states patch semantics ('Only the fields you pass are sent') and rules out state transitions ('State changes ... are deliberately not available'), which is strong when-not guidance. However, it does not name which sibling tool to use for those state changes, leaving the agent to search for an alternative.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.