Skip to main content
Glama
nh4ttruong

secobserve-mcp

by nh4ttruong
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Trigger SecObserve Built-In Scan

secobserve_trigger_scan

Trigger OSV or VulnerableCode vulnerability scans on a product's known components after SBOM import to generate findings.

Instructions

Run SecObserve's own OSV or VulnerableCode scan over a product's known components.

These scanners need no report: they look up the components SecObserve already has, which is why they are the usual follow-up to an SBOM import. Each must be enabled on the product (osv_enabled / vulnerablecode_enabled) or the call is rejected. SecObserve scans inside the request, so a product with many components can exceed the HTTP timeout. When it does, this returns the state of the scan rather than a bare timeout, because the scan is still running.

Args: scanner (str): "osv" or "vulnerablecode". product_id (int): Product to scan. branch_id (Optional[int]): One branch, or every branch when omitted.

Returns: str: observations_new, observations_updated and observations_resolved for the scan, one per line. On a timeout, a "Still running" text instead: no counts, the secobserve_list call on vulnerability_checks that shows the scan landing, and that row's last_import from before the call, which a later value beats.

Examples: - Use when: "re-check product 12 against osv.dev" -> scanner="osv", product_id=12 - Use when: right after importing an SBOM, to get findings for its components. - Don't use when: the product has no components yet (import an SBOM first).

Error Handling: 400 "OSV scan is not enabled for product X" means enable it on the product first (secobserve_update, data={"osv_enabled": true}). A timeout is answered with "Still running" and the query that settles it; never retry on one, since the first scan is still going.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scannerYes'osv' queries osv.dev for the product's known components; 'vulnerablecode' queries a configured VulnerableCode instance. Each must be enabled on the product first.
branch_idNoScan one branch only. Omit to scan every branch of the product.
product_idYesProduct to scan.

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: -{
-  "TriggerScanInput": {
-    "additionalProperties": false,
-    "description": "Input model for running a built-in scanner.",
-    "properties": {
-      "branch_id": {
-        "anyOf": [
-          {
-            "minimum": 1,
-            "type": "integer"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "default": null,
-        "description": "Scan one branch only. Omit to scan every branch of the product.",
-        "title": "Branch Id"
-      },
-      "product_id": {
-        "description": "Product to scan.",
-        "minimum": 1,
-        "title": "Product Id",
-        "type": "integer"
-      },
-      "scanner": {
-        "description": "'osv' queries osv.dev for the product's known components; 'vulnerablecode' queries a configured VulnerableCode instance. Each must be enabled on the product first.",
-        "enum": [
-          "osv",
-          "vulnerablecode"
-        ],
-        "title": "Scanner",
-        "type": "string"
-      }
-    },
-    "required": [
-      "scanner",
-      "product_id"
-    ],
-    "title": "TriggerScanInput",
-    "type": "object"
-  }
-}
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / branch_id
      Added value: +{
+  "anyOf": [
+    {
+      "minimum": 1,
+      "type": "integer"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Scan one branch only. Omit to scan every branch of the product.",
+  "title": "Branch Id"
+}
    • removedInput schema / properties / params
      Removed value: -{
-  "$ref": "#/$defs/TriggerScanInput"
-}
    • addedInput schema / properties / product_id
      Added value: +{
+  "description": "Product to scan.",
+  "minimum": 1,
+  "title": "Product Id",
+  "type": "integer"
+}
    • addedInput schema / properties / scanner
      Added value: +{
+  "description": "'osv' queries osv.dev for the product's known components; 'vulnerablecode' queries a configured VulnerableCode instance. Each must be enabled on the product first.",
+  "enum": [
+    "osv",
+    "vulnerablecode"
+  ],
+  "title": "Scanner",
+  "type": "string"
+}
    • changedInput schema / required
      Previous value: -[
-  "params"
-]New value: +[
+  "scanner",
+  "product_id"
+]
  2. First observedv0.1.2

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already indicate a non-readonly, non-destructive, non-idempotent operation, but the description adds crucial behavioral context: the scan runs synchronously inside the HTTP request and can exceed timeouts, and the tool returns 'Still running' instead of a bare timeout. It also explains the error response for disabled scans, which is not in the schema. This goes beyond the annotations to inform the agent about asynchronous behavior and error handling, though not as rich as a full timeout/retry policy.

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 well-structured with clear sections for description, args, returns, examples, and error handling. It's front-loaded with the core purpose and usage prerequisites, and every sentence contributes to the agent's understanding. There is no fluff or repetition, and the examples and error handling are concise and actionable.

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?

Given the tool's complexity (synchronous scan, timeouts, error codes, dependency on product settings), the description is complete. It covers prerequisites, return format, timeout behavior, and error handling. The output schema exists, so the return format is partially documented, but the description adds the timeout-specific return and the follow-up query, making it comprehensive enough for an agent to call 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?

The schema covers 100% of parameters with descriptions (scanner enum, product_id, branch_id), so the baseline is 3. The description adds some value by explaining the 'Still running' return behavior tied to the branch_id and providing usage examples, but it doesn't materially enhance the semantics of the parameters beyond what the schema already states.

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 clearly states the verb ('trigger', 'run') and resource ('SecObserve's own OSV or VulnerableCode scan over a product's known components'), distinguishing it from other tools that import reports or list observations. It specifies the two scanner types and the prerequisite on product components, making its purpose unambiguous and setting it apart from siblings like secobserve_api_import and secobserve_list.

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 provides explicit when-to-use examples ('re-check product 12 against osv.dev', 'right after importing an SBOM') and a when-not-to-use ('product has no components yet'), plus a clear alternative (import an SBOM first). It also mentions the required enablement flags (osv_enabled/vulnerablecode_enabled), leaving no ambiguity about prerequisites or scheduling.

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