Skip to main content
Glama
Sign In
Kiln

Kiln

by codeofaxel
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python

backup_database

Destructive

Creates a copy of the Kiln SQLite database, redacting API keys, access codes, and payment references by default to keep sensitive data out of backups.

Instructions

Back up the Kiln database with optional credential redaction.

        Creates a copy of the SQLite database.  By default, sensitive fields
        (API keys, access codes, payment refs) are replaced with "REDACTED"
        in the backup.

        Args:
            output_path: Destination file path.  Defaults to
                ``~/.kiln/backups/kiln-YYYYMMDD-HHMMSS.db``.
            redact: If ``True`` (default), redact credentials in the backup.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "backup_database"
  }
}

Input Schema

NameRequiredDescriptionDefault
redactNoIf ``True`` (default), redact credentials in the backup. Default: true.
output_pathNoDestination file path. Defaults to ``~/.kiln/backups/kiln-YYYYMMDD-HHMMSS.db``.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.5.1
    • addedInput schema / properties / output_path / description
      Added value: +"Destination file path.  Defaults to ``~/.kiln/backups/kiln-YYYYMMDD-HHMMSS.db``."
    • changedInput schema / properties / redact / description
      Previous value: -"Default: true."New value: +"If ``True`` (default), redact credentials in the backup. Default: true."
  2. Changed3 schema fields changedv1.5.0
    • removedInput schema / properties / output_path / default
      Removed value: -null
    • removedInput schema / properties / redact / default
      Removed value: -true
    • addedInput schema / properties / redact / description
      Added value: +"Default: true."
  3. First observedv0.1.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already flag readOnlyHint=false and destructiveHint=true, and the description adds real substance beyond them: exactly which fields are redacted and to what value, that redaction is on by default, and where the file lands. It omits behavior directly relevant to destructiveHint, however, such as whether an existing file at output_path is overwritten and whether the source database is locked during the copy.

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?

The lead sentence carries the core purpose and the rest is scoped and short, front-loading the important default (redaction on). The docstring-style 'Args:' block largely duplicates the JSON schema, which is mild waste but not harmful.

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?

For a low-complexity two-parameter tool this covers most of what is needed, but with no output schema the description should say what the call returns (the written path, size, or confirmation) and how it behaves if the destination exists. Those gaps matter for an agent that needs to report or chain off the backup result.

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

Parameters3/5

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

Schema description coverage is 100%, and both parameters are already documented in the schema with types and defaults. The description restates the same default path and redaction semantics without adding format or edge-case detail, so the baseline of 3 is appropriate.

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 names a specific verb and resource ('Back up the Kiln database') and states the scope includes optional credential redaction, then clarifies the artifact is a copy of the SQLite database. It is unambiguous what the tool produces, but it never distinguishes itself from nearby siblings such as database_status or cloud_backup_configure.

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 only implied: an agent can infer this is the tool to snapshot the local database before risky work, and the defaults (timestamped path, redaction on) are stated. There is no explicit when-to-use, when-not-to-use, prerequisite, or named alternative (e.g., cloud backup tooling).

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