secobserve-mcp

Describe SecObserve Resource

secobserve_describe_resource

Read-onlyIdempotent

Read a resource's live OpenAPI schema to see available filters, fields, and enums before creating, updating, or guessing filter names.

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: 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
`resource`	Yes	Resource name from secobserve_list_resources (e.g. 'observations').
`include_detail_path`	No	Also describe the /{id}/ path (the fields returned by secobserve_get and accepted by update).

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedv0.3.0Sep 20, 2026

removedInput schema / $defs

Removed value: -{
-  "DescribeResourceInput": {
-    "additionalProperties": false,
-    "description": "Input model for describing one resource against the live OpenAPI schema.",
-    "properties": {
-      "include_detail_path": {
-        "default": true,
-        "description": "Also describe the /{id}/ path (the fields returned by secobserve_get and accepted by update).",
-        "title": "Include Detail Path",
-        "type": "boolean"
-      },
-      "resource": {
-        "description": "Resource name from secobserve_list_resources (e.g. 'observations').",
-        "title": "Resource",
-        "type": "string"
-      }
-    },
-    "required": [
-      "resource"
-    ],
-    "title": "DescribeResourceInput",
-    "type": "object"
-  }
-}

addedInput schema / additionalProperties
```
Added value: +false
```

addedInput schema / properties / include_detail_path

Added value: +{
+  "default": true,
+  "description": "Also describe the /{id}/ path (the fields returned by secobserve_get and accepted by update).",
+  "title": "Include Detail Path",
+  "type": "boolean"
+}

removedInput schema / properties / params

Removed value: -{
-  "$ref": "#/$defs/DescribeResourceInput"
-}

addedInput schema / properties / resource

Added value: +{
+  "description": "Resource name from secobserve_list_resources (e.g. 'observations').",
+  "title": "Resource",
+  "type": "string"
+}

changedInput schema / required

Previous value: -[
-  "params"
-]New value: +[
+  "resource"
+]

First observedv0.1.2Sep 17, 2026

TDQS

A4.6/5.0

Behavior5/5

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

Annotations already declare readOnlyHint and idempotentHint, and the description adds meaningful behavioral context: the schema is sourced live from /api/oa3/schema/ on the running backend rather than a hand-written list. It also discloses error behavior for unknown resources and for instances that do not serve the schema, which goes beyond the annotations.

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 for usage, arguments, return format, examples, and error handling. It loses one point because the 'Returns' block largely duplicates what an output schema would already provide, adding redundancy.

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 covers purpose, when to use it, what parameters mean, the return structure, and failure modes. It is fully sufficient for an agent to invoke it correctly and to use its output effectively, especially given the rich annotations and output schema.

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?

Schema description coverage is 100%, so both parameters are already documented in the schema. The description's Args section largely repeats the schema text and adds only minor usage context, satisfying the baseline but not exceeding it.

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 and resource ('Read the deployed instance's OpenAPI schema for one resource') and immediately distinguishes its focus on filters, fields, and enums. It also contrasts itself with secobserve_list_resources, so an agent can tell exactly what this tool provides.

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: 'Call it before create/update, and before guessing a filter name.' It provides concrete examples with 'Use when' and 'Don't use when', and names the alternative (secobserve_list_resources). This leaves no ambiguity about when to select this tool.

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

Deploy Server