Skip to main content
Glama
dataplat

dbatools-mcp-server

Official
by dataplat

get_dbatools_command_help

Retrieves complete help for a dbatools command, including parameters and examples from comment-based help.

Instructions

Get the full normalized help for a specific dbatools command, including parameters and examples sourced from comment-based help.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
commandNameYesExact command name, e.g. Get-DbaDatabase
Behavior3/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. It accurately states the tool provides help (a read operation), but it does not disclose behavior such as response format size, performance impact, or required permissions.

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 sentence that conveys the tool's purpose, output content (parameters and examples), and source (comment-based help) without any extraneous words.

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 description is adequate for a simple tool with one parameter and no output schema. It explains the output includes parameters and examples. However, it could be improved by clarifying what 'normalized help' means or specifying the output format (e.g., text).

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 description does not add meaning beyond the schema; the schema already describes the parameter with the same example. Since schema coverage is 100%, the baseline score of 3 is appropriate.

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 uses the specific verb 'Get' and identifies the resource as 'full normalized help for a specific dbatools command.' It clearly distinguishes from sibling tools like list_dbatools_commands (which lists commands) and invoke_dbatools_command (which executes commands).

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

Usage Guidelines3/5

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

The description implies the tool should be used when help on a specific dbatools command is needed, but it does not explicitly state when to use it or when to avoid it, nor does it mention alternatives among the sibling tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/dataplat/dbatools-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server