secobserve-mcp

Describe SecObserve Resource

secobserve_describe_resource

Read-onlyIdempotent

Need to know which filters or fields a SecObserve resource accepts? Retrieve the live OpenAPI schema to see parameters, required fields, and enums before create or update.

Instructions

Read the deployed instance's OpenAPI schema for one resource: filters, fields, enums.

This is the authoritative answer to "what can I filter on" and "what does the body need", because it comes from /api/oa3/schema/ on the running backend rather than from a hand-written list. Call it before create/update, and before guessing a filter name.

Args: params (DescribeResourceInput): Validated input containing: - resource (str): Resource name from secobserve_list_resources. - include_detail_path (bool): Also describe /{id}/ (default True).

Returns: str: JSON with the schema: { "resource": str, "path": str, "operations": { "": { "GET": {"parameters": [{"name": str, "in": str, "type": str, "enum": [...]}], "response_fields": [str]}, "POST": {"body_fields": {"": {"type": str, "required": bool, "enum": [...]}}} }, "": {...} }, "actions": [{"name": str, "method": str, "detail": bool, "summary": str}] }

Examples: - Use when: "which statuses can I filter observations by?" -> resource="observations" - Use when: before secobserve_create on 'branches', to see required fields. - Don't use when: you only need the list of resources (use secobserve_list_resources).

Error Handling: Returns an error naming the valid resources when 'resource' is unknown. If the instance does not serve the schema, says so and points at secobserve_list_resources for the static catalogue.

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

A5/5.0

Behavior5/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false. The description adds useful behavioral context beyond these: it sources data from /api/oa3/schema/ on the running backend, explains that unknown resource names produce an error naming valid resources, and states fallback behavior when the schema endpoint is unavailable. No contradiction with annotations.

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 longer than average but every section earns its place: purpose, args, return format, examples, and error handling are clearly labeled. The most important statement about authoritative OpenAPI sourcing is front-loaded in the first sentence. Headings and bullet-style examples make the length scannable rather than bloated.

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?

The description is complete for a read-only introspection tool. It explains the return JSON structure in enough detail that an agent knows what to expect, gives error-handling behavior, and includes usage examples. Since an output schema is also present, the description complements rather than replaces structured return documentation.

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?

Context signals report 0% schema description coverage, so the description must carry parameter semantics. It does: 'resource (str): Resource name from secobserve_list_resources' and 'include_detail_path (bool): Also describe /{id}/ (default True).' The examples further clarify what the resource parameter should contain. This fully compensates for the reported coverage gap.

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 the deployed instance's OpenAPI schema for one resource: filters, fields, enums.' It clearly distinguishes this from sibling tools like secobserve_list_resources by stating it describes one resource in detail rather than listing resources. The phrase 'authoritative answer to what can I filter on and what does the body need' reinforces the exact purpose.

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 usage conditions: 'Call it before create/update, and before guessing a filter name.' It provides concrete examples of when to use it ('which statuses can I filter observations by?') and an explicit exclusion: 'Don't use when: you only need the list of resources (use secobserve_list_resources).' This makes alternative selection unambiguous.

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

Deploy Server