Skip to main content
Glama

akb_update

Update an existing document by specifying only the fields to change. Modify title, content, status, tags, and relationships with a commit message.

Instructions

Update an existing document. Only provide fields you want to change.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uriYesDocument URI
contentNoNew document body (replaces existing)
titleNoNew title
statusNo
tagsNo
summaryNo
depends_onNoUpdate dependency list (akb:// URIs)
related_toNoUpdate related list (akb:// URIs)
messageNoCommit message describing the change
fileNoLocal file path to read as document body (alternative to content). Provide either file or content, not both.
Behavior2/5

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

No annotations are provided, so the description bears full responsibility. It confirms mutation via 'Update' but omits behavioral details such as whether the update is atomic, what happens to omitted fields, authentication requirements, or side effects. The description is too sparse for a mutation tool with 10 parameters.

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, front-loaded sentence that efficiently conveys the tool's purpose and key constraint. Every word earns its place, with no redundancy.

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

Completeness2/5

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

Given the complexity (10 parameters, no output schema, no annotations), the description is too brief. It omits critical information such as return values, error handling, and behavioral details. The user lacks sufficient context to use the tool confidently without referring to external documentation.

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?

With schema description coverage at 70%, the baseline is 3. The description adds the key guidance 'Only provide fields you want to change' which clarifies partial update semantics. However, it does not elaborate on parameter specifics beyond what the schema already provides, so no extra value is added.

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 clearly states 'Update an existing document' with a specific verb and resource. It distinguishes from siblings like akb_delete or akb_put, but does not differentiate from akb_edit, which is a similar update tool. This minor ambiguity prevents a perfect score.

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?

The instruction 'Only provide fields you want to change' implies a partial update semantics, which is useful guidance. However, no explicit context is given for when to use this tool versus alternatives like akb_put (full replace) or akb_delete, leaving some ambiguity.

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/dnotitia/akb'

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