secobserve-mcp

Generate SecObserve VEX Document

secobserve_vex_document

Generate a VEX document from assessed vulnerability observations in CSAF, OpenVEX, or CycloneDX format. Pass a document_base_id to revise an existing document and bump its version.

Instructions

Generate a CSAF, OpenVEX or CycloneDX VEX document from assessed observations, or revise one.

The document's content comes from the assessments already recorded: statuses like "Not affected" plus their VEX justification. Assess first, generate second. Passing document_base_id revises that document and bumps its version instead of creating a new one. The generated file is written to the server's export directory.

Args: params (VexDocumentInput): Validated input containing: - format (str): "csaf", "openvex" or "cyclonedx". - document_id_prefix (Optional[str]): Required to create, and to identify a document to update. - document_base_id (Optional[str]): Present only when updating. - product_id (Optional[int]) and/or vulnerability_names (Optional[List[str]]): the scope when creating; at least one is required. - branch_ids (Optional[List[int]]): Restrict to these branches. - fields (Optional[dict]): Format-specific metadata (CSAF: title, publisher_name, publisher_category, publisher_namespace, tracking_status, tlp_label; OpenVEX: id_namespace, author, role; CycloneDX: author, manufacturer). - filename (Optional[str]): Base filename for the written document.

Returns: str: A line giving the absolute path and byte size of the document written to the export directory.

Examples: - Use when: "publish an OpenVEX for product 12" -> format="openvex", document_id_prefix="acme-vex", product_id=12, fields={"id_namespace": "https://acme.example", "author": "Acme Security"} - Use when: "a CSAF advisory for CVE-2024-3094 across our products" -> format="csaf", vulnerability_names=["CVE-2024-3094"], fields={...} - Use when: reissuing after new assessments -> pass document_base_id. - Don't use when: importing someone else's VEX (use secobserve_upload_file, kind="vex").

Error Handling: 400 names the missing format-specific field; read the exact set with secobserve_describe_resource on the matching vex_* resource. A document with no qualifying assessments is generated but empty of statements.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`params`	Yes

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.2Sep 17, 2026

TDQS

A4.6/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, destructiveHint=false, so the safety profile is known. The description adds valuable behavioral context: the document is written to the server's export directory, a document with no qualifying assessments is generated but empty of statements, and error handling returns 400 naming the missing format-specific field. This goes beyond what annotations provide, though it doesn't detail side effects like overwriting existing files.

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 well-structured with clear sections (Args, Returns, Examples, Error Handling) and front-loads the core purpose. It is somewhat long, but every section earns its place: the examples are concrete, the error handling is actionable, and the 'Assess first, generate second' rule is critical. Minor redundancy with the schema's field descriptions prevents a 5.

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 (create vs. revise, three formats, format-specific fields, scope requirements), the description is complete. It covers prerequisites, parameter relationships, return value, error handling, and edge cases (empty document). The output schema exists, so return values need no further explanation. An agent has everything needed to call this tool correctly.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate. It does: it explains the role of each parameter (format, document_id_prefix, document_base_id, product_id/vulnerability_names, branch_ids, fields, filename) and adds meaning beyond the schema, such as 'Required to create, and to identify a document to update' and 'at least one is required'. The schema itself has descriptions for each property, but the description adds the create-vs-update semantics and the required-field relationships.

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 states a specific verb ('Generate'/'revise') and resource ('CSAF, OpenVEX or CycloneDX VEX document from assessed observations'), and clearly distinguishes create vs. revise behavior. It also names the sibling alternative (secobserve_upload_file) for importing someone else's VEX, so an agent can tell this tool apart from related tools.

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 explicit when-to-use guidance: 'Assess first, generate second', 'Passing document_base_id revises that document', and 'Don't use when: importing someone else's VEX (use secobserve_upload_file, kind="vex")'. It also provides concrete examples mapping natural-language requests to parameter values, which is strong usage guidance.

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

Deploy Server