Skip to main content
Glama
dnotitia

akb

by dnotitia
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

akb_publication_snapshot

Convert a table_query publication into a snapshot by caching its current result to S3. Subsequent visits return the cached result, identified by slug alone.

Instructions

Freeze a table_query publication's current result to S3 and flip its mode to 'snapshot' (subsequent visits return the cached result). Identified by slug alone — the vault is resolved from the publication. Returns the updated publication dict.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesPublication slug
_vault_skill_ackNoOpaque acknowledgement returned as vault_skill.ack_token. After applying that guide, retry the unchanged operation with this value. The bundled proxy supplies it automatically.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.14
    • addedInput schema / properties / _vault_skill_ack
      Added value: +{
+  "description": "Opaque acknowledgement returned as vault_skill.ack_token. After applying that guide, retry the unchanged operation with this value. The bundled proxy supplies it automatically.",
+  "maxLength": 128,
+  "type": "string"
+}
  2. Changed2 schema fields changedv2.0.7
    • removedInput schema / properties / vault
      Removed value: -{
-  "description": "Vault name",
-  "type": "string"
-}
    • changedInput schema / required
      Previous value: -[
-  "vault",
-  "slug"
-]New value: +[
+  "slug"
+]
  3. Addedv2.0.4
  4. Removedv2.0.1
  5. First observedv0.1.0

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does explain the core side effects: freezing the result to S3, flipping the mode to snapshot, and caching behavior for subsequent visits. However, it omits details about reversibility, potential data loss, permissions required, or error conditions (e.g., if the publication is not a table_query publication), leaving some behavioral ambiguity.

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 concise and front-loaded, with two sentences that convey the core action, the identification method, and the return value without any filler. Every sentence earns its place, and the structure is efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers the essential aspects: the operation, the mode change, the caching behavior, identification, and the return type. It could mention prerequisites (e.g., the publication must be a table_query publication) and whether the operation is reversible, but for a tool with no output schema and moderate complexity, it is largely complete.

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?

The input schema already has 100% coverage, so the baseline is 3. The description adds value by clarifying that slug alone is sufficient and that the vault is resolved from the publication, which is not obvious from the schema's simple 'Publication slug'. This extra context makes the parameter semantics clearer, warranting a 4.

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 tool's purpose: it freezes a table_query publication's current result to S3 and flips its mode to 'snapshot', which differentiates it from siblings like akb_publish and akb_unpublish. The verb 'freeze' and resource 'publication' are specific, and it clarifies that the vault is resolved from the slug, eliminating ambiguity about required parameters.

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?

The description provides clear context on when to use the tool: when you want a publication to serve a cached result instead of re-querying, and that it applies specifically to table_query publications. It notes that the vault is derived from the publication, but does not explicitly mention alternatives or when not to use it (e.g., for non-table_query publications), so it falls short of a 5.

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