Skip to main content
Glama

Read database status

databaseStatus
Read-onlyIdempotent

Read the managed database Tofu records for one owned project, as its Database page shows it: state and region, what Tofu could see of the app’s own schemas (schema: counts and table names, never a row), what an archive could not copy (archive), an archive warning (inactivity), a stored archive (storedArchive) and a restore’s progress (restore). The answer’s own message and nextSteps, and those in schema, archive, inactivity and restore, say what the state means, the next step and who takes it. schema.state empty means the app has no table of its own yet. archive.reentry names sign-in secrets a restore would need again: this tool neither takes nor returns their values. It never returns a password, connection string or key, and writes nothing. An unavailable read is unavailable, never an empty schema.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "projectId": "<projectId>"
    },
    "name": "databaseStatus"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectIdYes

Output Schema

NameRequiredDescriptionDefault
refYes
exitYes
stateYes
regionYes
schemaYes
archiveYes
enabledYes
messageYes
restoreNo
providerYes
nextStepsYes
inactivityNo
agentPromptYes
lifecycleModeNo
storedArchiveNo
environmentKeysYes
lifecycleFailureYes
requiresDeploymentYes
manualRetentionSinceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the already-supplied readOnly/idempotent annotations, it discloses the security boundary ('never returns a password, connection string or key', `archive.reentry` names secrets it neither takes nor returns), the write behavior ('writes nothing'), and a meaningful error semantic ('an unavailable read is unavailable, never an empty schema') that prevents an agent from misreading a failure as an empty database.

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?

Purpose is front-loaded in the first clause, and each subsequent clause carries distinct information (returned sections, message fields, empty-state meaning, secret non-disclosure). The second sentence is a long chained construction with heavy parentheticals, which slightly hurts readability, but there is no filler.

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?

Even though an output schema exists and return values need not be explained, the description goes further by interpreting key fields (`schema.state` = 'empty', `archive.reentry`) and error semantics. For a single-parameter read with annotations covering the safety profile, nothing an agent needs to invoke or interpret it correctly is missing.

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?

Schema coverage is 0% for the single `projectId` parameter, so the description must compensate; it does add the ownership constraint ('one owned project'), which is meaning the schema's uuid pattern cannot express. It does not restate the uuid format, which is unnecessary since the schema already constrains it.

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 ('Read') and a precisely scoped resource ('the managed database Tofu records for one owned project'), then enumerates exactly what the record contains: state and region, schema counts and table names, archive gaps, inactivity warning, storedArchive, restore progress. This is clearly distinguishable from siblings like databaseBackups, databaseArchiveDownload and databaseRestore, which act on the artifacts rather than reporting status.

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 by 'as its Database page shows it' and by the note that the returned `message`/`nextSteps` indicate the next action, so an agent can infer this is the entry-point inspection tool. However, it never explicitly says when to call this instead of databaseBackups, databaseReconcile or databaseRestore, nor any precondition beyond the project being owned.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources