Skip to main content
Glama
codeofaxel

Kiln

by codeofaxel
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python

lock_design

Toggle a design between local-only and Kiln account storage: prevent saves to the account while branching, merging, and history still work.

Instructions

Keep a design on this computer only: never saved to the person's Kiln account.

        A locked design is never saved to the Kiln account, by any door:
        a cloud push, an automatic save after each version, a push of one
        of its signed releases, or a pull request.  Each is refused and
        says the design is locked.  Branching, merging and the history
        views keep working; when Kiln's servers run one of those, the
        design passes through them for that call only and is not kept
        there.  Locking removes nothing already in the account.  Free on
        every plan.

        Args:
            design_id: The design to lock or unlock.
            locked: ``True`` (the default) to lock it, ``False`` to unlock it.

        Returns:
            ``locked`` (the state it is now in) and ``said``: a sentence
            to show the person, saying what the lock does and does not do.

Input Schema

NameRequiredDescriptionDefault
lockedNoDefault: true.
design_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.5.0

TDQS

A4.3/5.0
Behavior5/5

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

With no annotations provided, the description carries the full behavioral burden and does so well: it enumerates the refused operations, explains pass-through behavior for server-side branch/merge/history calls, states that existing account data is not removed, and mentions return values. This is unusually complete for a mutation tool.

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 core meaning is front-loaded and the structure is readable, but the opening sentence and the following paragraph repeat that a locked design is never saved to the Kiln account. The Args/Returns structure is useful, though somewhat verbose.

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 two-parameter mutation tool with no annotations and no output schema, the description covers the important behavioral edges: what is blocked, what still works, what is not deleted, and what is returned. An agent has enough context to invoke it correctly.

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 only 50%, so the description must compensate, and it does: design_id is identified as the design to lock or unlock, and locked is explained as True for lock and False for unlock. It does not specify the expected design_id format, which keeps it from a 5.

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 states a specific action-resource pair: lock/unlock a design so it stays local and is never saved to the Kiln account. The effect is clear, but it does not explicitly distinguish this tool from similarly named siblings such as keep_design or the cloud-push tools.

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 clear usage context by explaining that the lock prevents all cloud-save paths while branching, merging, and history still work. It also notes that locking removes nothing already in the account, but it does not name an alternative tool or explicitly say when to choose unlock versus lock beyond the locked argument.

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