Skip to main content
Glama
dataplat

dbatools-mcp-server

Official
by dataplat

list_dbatools_commands

Read-onlyIdempotent

Search and filter dbatools commands by verb, noun, keyword, or risk level to identify the PowerShell command for a task.

Instructions

Search and list dbatools commands. Filter by verb, noun, keyword, or risk level.

Input Schema

NameRequiredDescriptionDefault
nounNoNoun fragment to match (e.g. Database, Login, AgentJob)
verbNoPowerShell verb (e.g. Get, Set, New, Remove, Test)
limitNoMaximum number of results (default 50, max 200)
keywordNoKeyword to search in name, synopsis, and description
riskLevelNoFilter by risk tier

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered without the description. The description adds only that filtering is supported, saying nothing about result ordering, pagination beyond the limit cap, or what each result entry contains.

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?

Two compact sentences with the core action front-loaded and the filter surface immediately after. No filler, no repetition of name or title.

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?

With all five optional parameters fully documented in the schema, no output schema, and annotations covering safety and world scope, the description is nearly sufficient for correct invocation. It stops just short by not indicating the shape or ordering of returned command entries.

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%, with per-parameter descriptions, examples (Database, Login, AgentJob; Get, Set, New), defaults and the riskLevel enum all documented in the schema. The description merely restates the four filter names, adding no matching semantics such as partial/substring behavior.

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?

States a specific verb+resource ('search and list dbatools commands') and names the four filter dimensions, so an agent immediately knows this is the discovery tool. It does not explicitly contrast itself with get_dbatools_command_help or invoke_dbatools_command, leaving sibling differentiation to the tool names.

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 phrase 'Search and list' implies a discovery-then-act workflow, and the filter list hints at narrowing before invoking. However, there is no explicit statement of when to choose this over get_dbatools_command_help or when to skip listing and invoke directly, and no exclusions or prerequisites.

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