Skip to main content
Glama
dataplat

dbatools-mcp-server

Official
by dataplat

check_dbatools_environment

Read-onlyIdempotent

Verify PowerShell and the dbatools module are installed and report help-index status, so you can confirm the environment is ready before running dbatools commands.

Instructions

Verify that PowerShell and the dbatools module are installed and report the help-index status.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and openWorld, so safety is covered structurally. The description adds that it checks installation state and reports help-index status, a useful behavioral detail, but says nothing about failure modes or output shape.

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?

One sentence, front-loaded with the verb and the two things verified, with no filler. Every clause earns its place.

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?

For a parameterless diagnostic with annotations covering safety and no output schema, the description is nearly sufficient. A brief note on what the report contains (e.g., installed/version/help-index accuracy) would close the remaining gap.

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

Parameters4/5

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

Zero parameters, so there is nothing for the description to disambiguate; the baseline applies. The description correctly signals a no-argument check operation.

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?

Specific verb ('Verify') with named resources (PowerShell, dbatools module) and a stated output focus (help-index status). It is clearly distinguishable from listing, help-lookup, and invocation siblings, though it doesn't name any of them.

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?

Usage is implied: this is a pre-flight/environment sanity check. There is no explicit when-to-use, when-not-to-use, or reference to the alternative tools, so the agent must infer that it precedes invoke_dbatools_command.

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