Skip to main content
Glama

msf_status

Read-only

Authenticate to a local Metasploit instance and retrieve Metasploit and API version details.

Instructions

Authenticate and get Metasploit and API version information.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so safety and network exposure are covered. The description adds that the call performs authentication and returns version metadata, but leaves unclear whether auth state is cached for later calls or whether credentials come from server config — and 'authenticate' sits in mild tension with readOnlyHint without being explained.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no filler, appropriate for a no-argument status call. It is arguably over-terse: the 'Authenticate' half is the most consequential behavior and receives no elaboration.

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

Completeness3/5

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

An output schema exists, so return values need no explanation, and the empty input schema is trivially complete. What is missing is the operational context an agent needs: whether calling this establishes auth for subsequent msf_* calls, and whether it is a mandatory first step.

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?

The tool takes zero parameters, so the baseline is 4; there is nothing for the description to disambiguate. It could still note that credentials come from configuration rather than arguments, which would have made the empty schema less surprising.

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 two concrete operations (authenticate, retrieve Metasploit/API version info) with a specific resource, so an agent knows exactly what it returns. It does not distinguish itself from siblings such as msf_rpc_methods or msf_rpc, which also probe server-side capability, so it stops short of a 5.

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?

There is no explicit when-to-use statement, no mention that this should be called before other msf_* tools, and no named alternative. The word 'Authenticate' only hints at a setup role; an agent must infer ordering and prerequisites on its own.

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