Skip to main content
Glama
Sign In
MCP Server for OSCAL

MCP Server for OSCAL

by dfkunstler
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

query_oscal_documentation

Search OSCAL documentation and return paged passages when a schema lacks the answer; use docId results to retrieve full documentation pages.

Instructions

Search OSCAL documentation (Knowledge Base if configured, plus local docs) and return paged passages. Use when a schema lacks the answer; for a model property try get_oscal_schema. Pass a hit's docId to get_oscal_documentation for the full page.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "query_oscal_documentation"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum items per page, 1-100. A page may hold fewer to fit the response budget.
queryYesQuestion or search terms about OSCAL.
offsetNoZero-based index of the first item.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.7.1
    • addedInput schema / properties / limit
      Added value: +{
+  "default": 10,
+  "description": "Maximum items per page, 1-100. A page may hold fewer to fit the response budget.",
+  "title": "Limit",
+  "type": "integer"
+}
    • addedInput schema / properties / offset
      Added value: +{
+  "default": 0,
+  "description": "Zero-based index of the first item.",
+  "title": "Offset",
+  "type": "integer"
+}
    • addedInput schema / properties / query / description
      Added value: +"Question or search terms about OSCAL."
  2. First observedv0.1.0

TDQS

A4.3/5.0
Behavior3/5

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

Since there are no annotations, the description carries the full burden of transparency. It adds helpful context by specifying that the search spans both the Knowledge Base and local documents, and it clarifies the output as 'paged passages,' which is a key operational detail.

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 uses two highly dense sentences, front-loading the primary function and immediately following with critical workflow and sibling tool routing advice. There is zero filler.

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 large set of sibling tools, this definition provides excellent context by defining the hierarchy of retrieval: query (search) -> get_oscal_documentation (fetch full text) -> get_oscal_schema (structured data lookup). It is highly complete for an informational search tool.

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?

The schema description coverage is 100%, meaning the parameters are already fully defined in the structured data. The description provides general context on the purpose of the search rather than adding semantic detail to the specific parameters.

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 clearly states the core function: to search OSCAL documentation (Knowledge Base and local docs) and return paged passages. It is specific about the content being searched and the format of the return value.

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 definition excels at guiding usage by specifying three distinct use cases: when a schema lacks an answer, when seeking a model property (use get_oscal_schema), and when needing the full content of a found passage (use get_oscal_documentation).

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