Skip to main content
Glama

server_get_backup_config

Retrieve backup configuration details for a Minecraft server, including compression settings, file exclusions, schedule, and retention limits.

Instructions

Get backup configuration for a Minecraft server (compression, exclusions, schedule, max backups)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
server_idYesServer ID or UUID

Implementation Reference

  • The handler for the `server_get_backup_config` tool, which fetches the backup configuration via an API client.
    server.tool(
      "server_get_backup_config",
      "Get backup configuration for a Minecraft server (compression, exclusions, schedule, max backups)",
      { server_id: z.string().describe("Server ID or UUID") },
      async ({ server_id }) => {
        try {
          const data = await client.get(`/servers/${server_id}/backups/config`);
          return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] };
        } catch (error) {
          const msg = error instanceof Error ? error.message : String(error);
          return { content: [{ type: "text", text: `Error: ${msg}` }], isError: true };
        }
      }
    );
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool retrieves configuration but does not specify whether this is a read-only operation, requires authentication, has rate limits, or what the output format looks like. For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

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 a single, efficient sentence that front-loads the core purpose ('Get backup configuration for a Minecraft server') and adds specific details in parentheses without unnecessary elaboration. Every word contributes to clarity, making it appropriately sized and well-structured.

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?

Given the tool's low complexity (one parameter, no output schema, no annotations), the description is complete enough for basic understanding. However, it lacks details on behavioral aspects (e.g., read-only nature, authentication needs) and output format, which are important for a configuration retrieval tool. The absence of an output schema increases the need for more context in the description.

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?

The input schema has 100% description coverage, with the single parameter 'server_id' documented as 'Server ID or UUID'. The description does not add any meaning beyond this, such as examples or constraints on the ID format. With high schema coverage, the baseline score of 3 is appropriate as the schema handles the parameter documentation adequately.

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?

The description clearly states the specific action ('Get') and resource ('backup configuration for a Minecraft server'), with explicit details on what configuration aspects are retrieved (compression, exclusions, schedule, max backups). It distinguishes from siblings like 'server_list_backups' (which lists backups) and 'server_update_backup_config' (which modifies configuration).

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention prerequisites (e.g., needing server access), exclusions (e.g., not for modifying configuration), or direct comparisons to sibling tools like 'server_get' (general server info) or 'crafty_get_config' (possibly broader configuration).

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/HadiCherkaoui/crafty-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server