Skip to main content
Glama
dnotitia

akb

by dnotitia
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

akb_publish

Publish documents, files, or table queries to a public share URL. Set password, expiry, and embed options, then get an absolute URL for sharing.

Instructions

Create a public, no-auth share URL for a document, file, or table query. Document/file: pass the resource uri. Table query: pass query_sql plus vault (and query_vault_names if the query touches more than one). Returns the canonical publication dict — slug is the only identifier you need; share_url is always an absolute URL ready to paste.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uriNoResource URI to publish — required when resource_type is document or file. Omit for table_query.
titleNoOverride the display title (defaults to the resource's own title).
vaultNoVault name. Required only for resource_type=table_query (doc/file vault is inferred from the URI).
passwordNoRequire this password to view the share.
max_viewsNoAuto-expire after N views.
query_sqlNoSELECT/WITH SQL with :param placeholders. resource_type=table_query only.
expires_inNoExpiration window: '1h', '7d', '30d', or 'never' (default).
allow_embedNoAllow the share to be embedded via iframe/oEmbed.
query_paramsNoParameter declarations: {name: {type, default, required}}. resource_type=table_query only.
resource_typeNoKind of resource. document/file → pass `uri`. table_query → pass `query_sql` + `vault`.document
section_filterNoFilter to a specific heading section. resource_type=document only.
_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.
query_vault_namesNoVaults the query reads from. Defaults to [vault]. resource_type=table_query only.

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. Changed14 schema fields changedv2.0.7
    • changedInput schema / properties / allow_embed / description
      Previous value: -"Whether the share can be embedded via iframe/oEmbed"New value: +"Allow the share to be embedded via iframe/oEmbed."
    • changedInput schema / properties / expires_in / description
      Previous value: -"Expiration: '1h', '7d', '30d', or 'never' (default)"New value: +"Expiration window: '1h', '7d', '30d', or 'never' (default)."
    • changedInput schema / properties / max_views / description
      Previous value: -"Auto-expire after N views"New value: +"Auto-expire after N views."
    • removedInput schema / properties / mode
      Removed value: -{
-  "default": "live",
-  "description": "live=query each request, snapshot=cache result in S3",
-  "enum": [
-    "live",
-    "snapshot"
-  ],
-  "type": "string"
-}
    • changedInput schema / properties / password / description
      Previous value: -"Password to protect the share"New value: +"Require this password to view the share."
    • changedInput schema / properties / query_params / description
      Previous value: -"Parameter declarations: {name: {type, default, required}}"New value: +"Parameter declarations: {name: {type, default, required}}. resource_type=table_query only."
    • changedInput schema / properties / query_sql / description
      Previous value: -"SELECT SQL with :param placeholders (for resource_type=table_query)"New value: +"SELECT/WITH SQL with :param placeholders. resource_type=table_query only."
    • changedInput schema / properties / query_vault_names / description
      Previous value: -"Vaults referenced by the query (defaults to [vault])"New value: +"Vaults the query reads from. Defaults to [vault]. resource_type=table_query only."
    • changedInput schema / properties / resource_type / description
      Previous value: -"Type of resource to share. For document/file, also pass uri. For table_query, pass query_sql + vault."New value: +"Kind of resource. document/file → pass `uri`. table_query → pass `query_sql` + `vault`."
    • removedInput schema / properties / section
      Removed value: -{
-  "description": "(document) Filter to a specific heading section",
-  "type": "string"
-}
    • addedInput schema / properties / section_filter
      Added value: +{
+  "description": "Filter to a specific heading section. resource_type=document only.",
+  "type": "string"
+}
    • changedInput schema / properties / title / description
      Previous value: -"Override display title"New value: +"Override the display title (defaults to the resource's own title)."
    • changedInput schema / properties / uri / description
      Previous value: -"Resource URI to publish (document or file). Omit for table_query."New value: +"Resource URI to publish — required when resource_type is document or file. Omit for table_query."
    • changedInput schema / properties / vault / description
      Previous value: -"Vault name (required for resource_type=table_query)"New value: +"Vault name. Required only for resource_type=table_query (doc/file vault is inferred from the URI)."
  3. Addedv2.0.4
  4. Removedv2.0.1
  5. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations present, the description carries the full burden and covers the two most operationally significant behaviors: the created share is publicly viewable with no authentication, and the return contract is a canonical publication dict where slug is the only identifier needed and share_url is always absolute. It could disclose idempotency-on-republish or caller permissions, but the core side effect is clearly stated.

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?

Three sentences, front-loaded with the action, then parameter-selection logic, then return-value guidance. Every sentence earns its place with zero filler and no restatement of the schema.

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?

For a 13-parameter, three-mode tool with no output schema and no annotations, the description covers the highest-risk decision (parameter selection per resource_type) and the essentials of the return contract (slug, share_url). Remaining details like expiry/password effects and re-publishing behavior are left to the schema or implicit, which is acceptable at this complexity level.

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 100%, so the baseline is 3, but the description adds cross-parameter meaning that per-parameter schema entries cannot convey: resource_type conditionally determines which of uri vs query_sql+vault must be supplied, and vault is inferred from the URI for doc/file yet must be passed explicitly for table_query. The slug guidance also reduces the agent's post-call burden.

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 opens with a specific verb-action pairing — 'Create a public, no-auth share URL' — and enumerates the three publishable resource kinds (document, file, table query). The 'no-auth share URL' framing clearly differentiates it from near-siblings like akb_set_public or the publication-management tools akb_unpublish and akb_publications.

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 states exactly when to call it (whenever a public, unauthenticated share is needed) and how to structure the call by resource type: document/file → uri; table_query → query_sql + vault, with a conditional note on query_vault_names for multi-vault queries. It stops short of explicitly naming excluded alternatives or when-not-to-use conditions, so not 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