Skip to main content
Glama
nh4ttruong

secobserve-mcp

Create SecObserve Record

secobserve_create

Create a SecObserve record (product, branch, service, rule, policy, member, etc.) by specifying resource and data. Returns the new record with its ID.

Instructions

Create a record in SecObserve (product, branch, service, rule, policy, member, ...).

Call secobserve_describe_resource for the resource first: SecObserve's serializers reject unknown fields and enforce enums, and its 400 bodies name the offending field.

Args: resource (str): Resource name supporting create. data (dict): Request body. response_format (ResponseFormat): "markdown" or "json".

Returns: str: The created record, including its new "id", as markdown or JSON.

Examples: - Use when: "add branch 'release-2.1' to product 12" -> resource="branches", data={"product": 12, "name": "release-2.1"} - Use when: "give user 7 the Writer role on product 12" -> resource="product_members", data={"product": 12, "user": 7, "role": "Writer"} - Don't use when: importing scanner findings (use secobserve_import_scan_file or secobserve_api_import -- creating observations by hand bypasses deduplication and rules).

Error Handling: Refused with a clear message when the resource has no create operation, or when SECOBSERVE_READ_ONLY is set. 400 responses are returned with the field-level detail from the API.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesRequest body. Call secobserve_describe_resource first for required fields and enums.
resourceYesResource name that supports create, e.g. 'products', 'branches'.
response_formatNo'markdown' for reading, 'json' for further processing.markdown

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.3.0
    • removedInput schema / $defs / CreateInput
      Removed value: -{
      -  "additionalProperties": false,
      -  "description": "Input model for creating a record.",
      -  "properties": {
      -    "data": {
      -      "additionalProperties": true,
      -      "description": "Request body. Call secobserve_describe_resource first for required fields and enums.",
      -      "title": "Data",
      -      "type": "object"
      -    },
      -    "resource": {
      -      "description": "Resource name that supports create, e.g. 'products', 'branches'.",
      -      "title": "Resource",
      -      "type": "string"
      -    },
      -    "response_format": {
      -      "$ref": "#/$defs/ResponseFormat",
      -      "default": "markdown",
      -      "description": "Output format."
      -    }
      -  },
      -  "required": [
      -    "resource",
      -    "data"
      -  ],
      -  "title": "CreateInput",
      -  "type": "object"
      -}
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / data
      Added value: +{
      +  "additionalProperties": true,
      +  "description": "Request body. Call secobserve_describe_resource first for required fields and enums.",
      +  "title": "Data",
      +  "type": "object"
      +}
    • removedInput schema / properties / params
      Removed value: -{
      -  "$ref": "#/$defs/CreateInput"
      -}
    • addedInput schema / properties / resource
      Added value: +{
      +  "description": "Resource name that supports create, e.g. 'products', 'branches'.",
      +  "title": "Resource",
      +  "type": "string"
      +}
    • addedInput schema / properties / response_format
      Added value: +{
      +  "$ref": "#/$defs/ResponseFormat",
      +  "default": "markdown",
      +  "description": "'markdown' for reading, 'json' for further processing."
      +}
    • changedInput schema / required
      Previous value: -[
      -  "params"
      -]New value: +[
      +  "resource",
      +  "data"
      +]
  2. First observedv0.1.2

TDQS

A5/5.0
Behavior5/5

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

Beyond the annotations, the description discloses important behaviors: refusal when a resource has no create operation or when SECOBSERVE_READ_ONLY is set, and 400 responses containing field-level detail. It also warns that creating observations by hand bypasses deduplication and rules, which is a meaningful behavioral consequence not captured by 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 well-structured into Args, Returns, Examples, and Error Handling sections, making it easy to scan. Every section earns its place, and the core purpose is front-loaded before details.

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 generic create endpoint with an open-world resource list, the description covers prerequisites, example payloads, return values, and failure modes. An agent has all needed guidance to invoke the tool correctly, especially with the instruction to call secobserve_describe_resource first.

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?

Although the schema already covers all parameters, the description adds substantial meaning through concrete examples, such as resource='branches' with data={'product': 12, 'name': 'release-2.1'} and resource='product_members' with role 'Writer'. It also clarifies response_format's purpose by describing markdown for reading and JSON for further processing.

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: 'Create a record in SecObserve' and lists concrete resource categories such as product, branch, service, rule, and member. It also differentiates itself from sibling import tools by explicitly saying not to use it for importing scanner findings.

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?

It gives explicit 'Use when' examples mapping natural-language requests to resource/data arguments, and a 'Don't use when' exclusion with named alternatives (secobserve_import_scan_file or secobserve_api_import). It also instructs the agent to call secobserve_describe_resource first, which is critical preparation for successful calls.

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