Skip to main content
Glama
Sign In
MCP Server for OSCAL

MCP Server for OSCAL

by dfkunstler
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

query_ssp

Retrieve OSCAL SSP data from the repository. Query security profiles by UUID or title, or view all loaded SSP instances with comprehensive metadata and child element counts.

Instructions

Return loaded OSCAL SSPs with metadata and childTypeCounts. For child elements, use list_ssp_control_implementations or list_ssp_system_components, then get_child_element.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "query_ssp"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum items per page, 1-100.
offsetNoZero-based index of the first item.
query_typeNo"all" (paged), "by_uuid", or "by_title" (exact, then full-text).all
query_valueNoUUID or title to match. Required for by_uuid and by_title.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.7.1
    • addedInput schema / properties / limit / description
      Added value: +"Maximum items per page, 1-100."
    • addedInput schema / properties / offset / description
      Added value: +"Zero-based index of the first item."
    • addedInput schema / properties / query_type / description
      Added value: +"\"all\" (paged), \"by_uuid\", or \"by_title\" (exact, then full-text)."
    • changedInput schema / properties / query_type / enum
      Previous value: -[
-  "all",
-  "by_uuid",
-  "by_title",
-  "by_type"
-]New value: +[
+  "all",
+  "by_uuid",
+  "by_title"
+]
    • addedInput schema / properties / query_value / description
      Added value: +"UUID or title to match. Required for by_uuid and by_title."
  2. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. The verb “return” implies a read operation and the mention of `childTypeCounts` adds return-shape context, but it does not explicitly state read-only behavior, permission requirements, pagination behavior, or error handling.

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 two sentences, front-loaded with the primary return behavior, and the second sentence provides useful sibling routing. There is no wasted text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has a rich input schema and no output schema, so the description should explain returns. It partially does so by naming metadata and `childTypeCounts`, and it handles child elements with sibling guidance. The remaining gap is that the return structure is only lightly described.

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 all four parameters are already documented in the input schema. The description does not add syntax or semantic detail about `query_type` or `query_value`, so the baseline of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states that it returns loaded OSCAL SSPs with metadata and `childTypeCounts`, which is a specific resource and return-shape statement. It distinguishes child-element queries by naming the appropriate sibling tools, but it does not clarify how `query_ssp` differs from the sibling `list_ssps`.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explicitly tells the agent to use `list_ssp_control_implementations` or `list_ssp_system_components` followed by `get_child_element` for child elements, which is useful routing guidance. However, it gives no guidance on when to choose `query_ssp` over `list_ssps` or other SSP-related query tools.

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