Skip to main content
Glama
Knuckles-Team

CISO Assistant MCP Server

Api compliance assessments update

ciso_assistant_api_compliance_assessments_update
Idempotent

Update an existing compliance assessment by ID via CISO Assistant to edit assessment details and maintain accurate GRC records.

Instructions

API endpoint that allows compliance assessments to be viewed or edited.

Input Schema

NameRequiredDescriptionDefault
idYes
bodyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.3.6

TDQS

C2.1/5.0
Behavior2/5

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

Annotations already declare the safety profile (readOnlyHint=false, idempotentHint=true, destructiveHint=false), so the description needed to add what they cannot: that this is a full-replacement update of the assessment body, what fields are expected, and what permissions or side effects apply. None of that is present, and the "viewed or edited" wording softens the write semantics that the annotation asserts.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single short sentence with no padding, but it spends its words on the generic "API endpoint that allows..." framing instead of front-loading the operation and the object it modifies. Brevity here comes from under-specification rather than economy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation endpoint with a completely undocumented free-form body, no output schema, and near-identical siblings for partial update/create/retrieve, the description leaves an agent unable to construct a correct call or confirm it chose the right tool. Given the complexity and zero schema coverage, far more was required.

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

Parameters2/5

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

Schema description coverage is 0%: `id` is an undescribed string and `body` is an opaque `anyOf` object with `additionalProperties: true`, so its accepted fields are documented nowhere. The description contributes no syntax, format, or field-level meaning beyond implying the body is a compliance assessment record.

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

Purpose2/5

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

The sentence pairs a vague formulation ("allows ... to be viewed or edited") with a resource name, but it reads as an auto-generated REST docstring that restates the endpoint rather than describing the operation. It does not say this is a full update (PUT) replacing a compliance assessment, and it cannot be distinguished from the many siblings such as `..._partial_update`, `..._create`, or `..._retrieve`.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus `compliance_assessments_partial_update` (patch a subset) or `compliance_assessments_retrieve` (read one). Worse, the phrase "viewed or edited" implies this endpoint is also the way to read a compliance assessment, which points the agent at the wrong sibling.

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