Skip to main content
Glama

server_info

Read-onlyIdempotent

Returns this server's database identity and runtime status so you can compare it with another server's health endpoint before writing and catch split data stores.

Instructions

This server's DB identity: db_path, data_dir, pid, started_at and version, plus status.

    Compare it against the other server's `GET /api/health` before writing so two servers pointed
    at different data dirs (a split store) are caught instead of silently diverging.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
pidYes
statusNook
db_pathYes
versionYes
data_dirYes
public_urlNoBase URL of the web UI (S2DOCS_PUBLIC_URL, else LAN fallback)
started_atYes
auth_requiredNoTrue when S2DOCS_AUTH_TOKEN is set (mutating /api and /mcp need a token)
confirms_jsonlNoAppend-only confirm journal a waiting agent watches (data_dir/confirms.jsonl)
latest_confirmNoAtomically-rewritten newest human confirm (data_dir/latest_confirm.json)
job_events_jsonlNoAppend-only job-event journal a waiting agent watches (data_dir/job_events.jsonl)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

The annotations already establish that this is a read-only, idempotent, non-open-world operation. The description adds meaningful operational context about why checking server identity matters before writes, though it does not discuss auth, rate limits, or status interpretation.

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 two tight sentences: first it states what identity fields are returned, then it explains the safe usage pattern. Nothing is wasted and the return-value context is front-loaded.

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?

The tool is a simple zero-argument server identity query with an output schema available, so return values need not be exhaustively described. The annotations cover safety semantics, and the description adds the key pre-write split-store rationale, making it complete enough for correct invocation.

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?

This tool takes zero input parameters, so the baseline for parameter semantics is 4. The schema is empty and the description appropriately does not invent input-parameter guidance.

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?

The description clearly identifies the resource as this server's DB identity and lists the concrete fields it reports. It is specific enough to distinguish this from broader host or build tools, though it does not explicitly name a sibling alternative.

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

Usage Guidelines4/5

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

It gives a clear usage context: compare this server's identity against the other server's health endpoint before writing, to catch split-store divergence. The guidance is actionable but does not state when not to use the tool or name a specific MCP sibling.

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