Skip to main content
Glama
nh4ttruong

secobserve-mcp

by nh4ttruong

SecObserve Instance Status

secobserve_status
Read-onlyIdempotent

Retrieve SecObserve instance status: version, health, settings, queue statistics, and PURL types to verify feature availability, approval requirements, and background worker activity.

Instructions

Read instance-level facts: version, health, public settings, queue statistics, PURL types.

Worth calling once at the start of a session: the version decides which features exist, and the settings say whether four-eyes approval, license management or the built-in scanners are switched on at all.

Args: params (StatusInput): Validated input containing: - kind (str): "version", "health", "settings", "background_tasks" or "purl_types". - product_id (Optional[int]): Required for kind="purl_types". - purl_type (Optional[str]): With kind="purl_types", look up one type.

Returns: str: The endpoint's JSON response. "version" gives {"version": str}; "health" gives a liveness object; "settings" gives the instance's public feature flags and intervals; "background_tasks" gives queue and worker statistics; "purl_types" gives the known package-URL types.

Examples: - Use when: starting work against an unfamiliar instance -> kind="settings" - Use when: "is approval required here?" -> kind="settings" - Use when: "are background workers keeping up?" -> kind="background_tasks" - Don't use when: you need per-product numbers (use secobserve_product_metrics).

Error Handling: "background_tasks" requires superuser and returns 403 for a product token. Everything else works for any authenticated caller.

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

A4.9/5.0
Behavior5/5

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

Annotations already declare readOnly, idempotent, and non-destructive hints, and the description adds value on top: it discloses that 'background_tasks' requires superuser and returns 403 for product tokens, and that other kinds work for any authenticated caller. This is exactly the kind of behavioral context annotations do not capture.

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

Conciseness4/5

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

The description is longer than typical, but every section serves a distinct purpose: overview, session-start recommendation, argument semantics, return mapping, examples, and error handling. It is well-structured and front-loaded with the key purpose, though it could be trimmed slightly without losing essential information.

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 read-only status tool with five distinct modes, the description covers invocation context, per-mode return shapes, authentication constraints, and a sibling alternative. Nothing an agent needs to correctly select and invoke this tool is missing.

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?

With schema description coverage reported at 0%, the description carries the full burden and does so thoroughly: it explains the 'kind' choices, states that product_id is required for 'purl_types', and clarifies the optional purl_type lookup. The Returns section maps each kind to its output shape, which goes well 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?

The description opens with a specific verb-resource pair, 'Read instance-level facts,' and enumerates the exact kind of data returned (version, health, settings, queue statistics, PURL types). It also explicitly steers away from per-product numbers, which distinguishes it from secobserve_product_metrics.

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?

Gives concrete when-to-use guidance ('Worth calling once at the start of a session'), including example triggers for 'settings' and 'background_tasks'. It also states a clear don't-use case and names the alternative tool, secobserve_product_metrics, making the decision explicit.

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