Skip to main content
Glama
Sign In
nagameTW

mcp-server-malcolm

by nagameTW
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Malcolm service status

malcolm_service_status
Read-only

Check readiness of every Malcolm service plus version and OpenSearch health before a hunt, revealing which optional subsystems like NetBox or filescan are deployed.

Instructions

Report readiness of each Malcolm service plus Malcolm version and OpenSearch health.

    Call this before a hunt to confirm the whole stack is up. For a bare
    is-the-API-alive check use malcolm_ping; for the OpenSearch cluster's
    green/yellow/red detail alone use cluster_health; for data freshness and
    per-dataset counts use malcolm_data_coverage. Returns a JSON summary with
    malcolm_version, mode, opensearch_health, a per-service readiness map, and an
    "N/total services ready" line. One probe failing adds an `errors` entry and
    keeps the rest; both failing is reported as an error, since there is then no
    status at all to report.

    The readiness map is also where the optional subsystems declare
    themselves, netbox, filescan and extracted_files among them. Read the
    relevant key here before taking an
    empty answer from malcolm_netbox_lookup or malcolm_file_scans as "no
    such asset" when it may mean "that subsystem is not deployed".

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations establish readOnlyHint, openWorldHint, and non-destructive behavior, so safety is covered. The description adds genuine behavioral context beyond that: one failing probe still yields partial results with an `errors` entry, whereas both failing is reported as an error, and the readiness map doubles as the place optional subsystems declare their deployment status. It stops short of covering latency, caching, or failure-mode specifics.

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?

Front-loads the purpose, then routes to alternatives, then explains the return shape and the partial-failure semantics. It is slightly long and the subsystem-declaration warning, while valuable, is a sentence or two more than strictly necessary, keeping it just under top marks.

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

Completeness5/5

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

For a no-arg read-only status tool with an output schema present, the description supplies everything an agent needs: what it reports, when to call it, which siblings overlap, what the returned JSON contains, how partial failures are represented, and the subsystem-deployment caveat. Return values need not be further enumerated because an output schema exists.

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. The description does not need to explain arguments, and it correctly avoids inventing any.

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?

States a specific verb (report readiness) and resource (each Malcolm service) plus additional scope (version, OpenSearch health). It explicitly distinguishes itself from the sibling tools malcolm_ping, cluster_health, and malcolm_data_coverage, telling the agent exactly which nearby tool answers which narrower question.

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

Usage Guidelines5/5

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

Gives an explicit when-to-use ('call this before a hunt to confirm the whole stack is up') and enumerates three alternatives with the conditions that select each. It goes further by warning the agent to read the readiness map before treating empty results from malcolm_netbox_lookup or malcolm_file_scans as an absence of data.

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