Skip to main content
Glama
Sign In
ms-sentinel-mcp-server

ms-sentinel-mcp-server

by dstreefkerk
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Remote

tool_docs_get

Retrieve raw markdown documentation from the Microsoft Sentinel MCP server for specific paths to access technical content and implementation details.

Instructions

Return the raw markdown for a given documentation path.

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": {
      "kwargs": "<kwargs>"
    },
    "name": "tool_docs_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
kwargsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.8/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool returns raw markdown but doesn't cover critical aspects like error handling, rate limits, authentication needs, or what happens if the path is invalid. For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

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 a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's appropriately sized and front-loaded, with every part contributing essential information, making it highly concise and well-structured.

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

Completeness2/5

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

Given the tool has no annotations, no output schema, and low parameter coverage, the description is incomplete. It lacks details on return values, error cases, and behavioral traits, making it inadequate for an agent to fully understand how to use this tool effectively in context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 1 parameter with 0% description coverage, and the description doesn't add any semantic details about the 'kwargs' parameter. It fails to explain what 'documentation path' means, its format, or examples, leaving the parameter's meaning unclear and not compensating for the low schema coverage.

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 the verb ('Return') and resource ('raw markdown for a given documentation path'), making the purpose specific and understandable. However, it doesn't distinguish this tool from its sibling 'tool_docs_list' or 'tool_docs_search', which appear to be related documentation tools, so it misses full sibling differentiation.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'tool_docs_list' or 'tool_docs_search'. It lacks context about prerequisites, exclusions, or specific scenarios, leaving the agent with no usage direction beyond the basic purpose.

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