Skip to main content
Glama
nh4ttruong

secobserve-mcp

by nh4ttruong

Update SecObserve Record

secobserve_update
Idempotent

Change fields of an existing SecObserve record using PATCH or PUT. Modify supported resources like products or rules while preserving omitted fields.

Instructions

Change fields of an existing SecObserve record.

Defaults to PATCH so omitted fields keep their values; set replace=True only when you intend PUT semantics, which blanks anything you leave out.

To change an observation's severity, status or priority, do NOT use this tool -- use secobserve_assess_observation, which writes an observation log, honours the approval workflow and keeps the audit trail intact.

Args: params (UpdateInput): Validated input containing: - resource (str): Resource name supporting update. - id (int): Primary key of the record. - data (dict): Fields to change. - replace (bool): False = PATCH (default), True = PUT. - response_format (ResponseFormat): "markdown" or "json".

Returns: str: The updated record as markdown or JSON.

Examples: - Use when: "disable general rule 4" -> resource="general_rules", id=4, data={"enabled": False} - Use when: "point product 12 at license policy 3" -> resource="products", id=12, data={"license_policy": 3} - Don't use when: assessing an observation (use secobserve_assess_observation).

Error Handling: Refused when the resource has no update operation or the server is read-only. 400 responses carry the API's field-level validation detail.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

A5/5.0
Behavior5/5

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

Adds behavioral detail beyond annotations: explains default PATCH semantics, the effect of replace=True (PUT blanks omitted fields), error handling (refused when no update op or read-only server, 400 validation), and warns that the tool bypasses audit trails for observation changes. This goes well beyond the annotations' basic hints.

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?

Despite being long, it is well-structured with clear sections (Args, Returns, Examples, Error Handling) and front-loads the most critical caveat about PATCH/PUT. Every sentence adds value; there is no fluff or repetition.

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?

Covers input parameters, output format, error cases, alternatives, and examples. For a complex update tool with nested parameters, this is complete enough for an agent to call it correctly without external help.

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

Parameters5/5

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

The description includes an Args section explaining each parameter (resource, id, data, replace, response_format) with additional context such as the meaning of replace and examples of data values. Even if schema coverage were low, this fully compensates.

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 and resource: 'Change fields of an existing SecObserve record.' It also differentiates from the sibling tool by explicitly saying 'do NOT use this tool' for observation assessments, which clearly separates its purpose from secobserve_assess_observation.

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?

Provides explicit when-to-use and when-not-to-use guidance, including a direct alternative: 'use secobserve_assess_observation' for observation changes. It also explains the PATCH/PUT distinction and gives concrete examples of when to use the tool, leaving no ambiguity.

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