Skip to main content
Glama
nh4ttruong

secobserve-mcp

SecObserve Instance Status

secobserve_status
Read-onlyIdempotent

Check instance-level status: version, health, public settings, queue statistics, and PURL types. Use at session start to verify available features, approval requirements, and worker health.

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: 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
kindYes'version' = SecObserve version; 'health' = liveness; 'settings' = the feature flags and intervals this instance exposes publicly; 'background_tasks' = queue statistics (superuser); 'purl_types' = the package-URL types known to the instance.
purl_typeNoWith kind='purl_types': look up one type (e.g. 'maven') instead of listing all.
product_idNoRequired for kind='purl_types': the product whose package-URL types to read.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.3.0
    • removedInput schema / $defs
      Removed value: -{
      -  "StatusInput": {
      -    "additionalProperties": false,
      -    "description": "Input model for reading instance status.",
      -    "properties": {
      -      "kind": {
      -        "description": "'version' = SecObserve version; 'health' = liveness; 'settings' = the feature flags and intervals this instance exposes publicly; 'background_tasks' = queue statistics (superuser); 'purl_types' = the package-URL types known to the instance.",
      -        "enum": [
      -          "version",
      -          "health",
      -          "settings",
      -          "background_tasks",
      -          "purl_types"
      -        ],
      -        "title": "Kind",
      -        "type": "string"
      -      },
      -      "product_id": {
      -        "anyOf": [
      -          {
      -            "minimum": 1,
      -            "type": "integer"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Required for kind='purl_types': the product whose package-URL types to read.",
      -        "title": "Product Id"
      -      },
      -      "purl_type": {
      -        "anyOf": [
      -          {
      -            "maxLength": 50,
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "With kind='purl_types': look up one type (e.g. 'maven') instead of listing all.",
      -        "title": "Purl Type"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "title": "StatusInput",
      -    "type": "object"
      -  }
      -}
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / kind
      Added value: +{
      +  "description": "'version' = SecObserve version; 'health' = liveness; 'settings' = the feature flags and intervals this instance exposes publicly; 'background_tasks' = queue statistics (superuser); 'purl_types' = the package-URL types known to the instance.",
      +  "enum": [
      +    "version",
      +    "health",
      +    "settings",
      +    "background_tasks",
      +    "purl_types"
      +  ],
      +  "title": "Kind",
      +  "type": "string"
      +}
    • removedInput schema / properties / params
      Removed value: -{
      -  "$ref": "#/$defs/StatusInput"
      -}
    • addedInput schema / properties / product_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "minimum": 1,
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Required for kind='purl_types': the product whose package-URL types to read.",
      +  "title": "Product Id"
      +}
    • addedInput schema / properties / purl_type
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 50,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "With kind='purl_types': look up one type (e.g. 'maven') instead of listing all.",
      +  "title": "Purl Type"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "params"
      -]New value: +[
      +  "kind"
      +]
  2. First observedv0.1.2

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations, the description discloses authentication requirements, a specific 403 behavior for product tokens on 'background_tasks', and per-kind return shapes. This gives the agent a full picture of what happens when the tool is invoked.

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?

The description is long but well-structured: summary sentence, rationale, args, returns, examples, and error handling. Every section contributes useful information, and the most important usage guidance is front-loaded.

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 multi-mode status tool with conditional parameters, an output schema, and auth-sensitive branches, the description covers use cases, return values, parameter requirements, and error behavior. Nothing the agent needs to select and invoke the correct mode is missing.

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?

Input schema coverage is 100%, and the schema already documents each parameter in detail. The description mostly restates the schema's parameter descriptions rather than adding new semantic constraints, though it does pair parameter choices with practical examples.

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 and resource: 'Read instance-level facts' and then enumerates the five distinct kinds of information. It also distinguishes itself from sibling tools by explicitly naming secobserve_product_metrics as the alternative for per-product numbers.

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?

The description gives concrete 'Use when' examples for starting a session, checking approval requirements, and monitoring background workers. It also states a clear exclusion: don't use this for per-product metrics, naming the sibling tool to use instead.

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