Skip to main content
Glama

Attach knowledge to an agent

kb_attach

Include or exclude a knowledge entry for one agent. Run agent_train afterwards or the change has no effect on answers. Scoped to one agent: it neither creates the entry (kb_upsert) nor deletes it, and there is no tool to delete a knowledge entry. Requires the "Agents" permission on the plan.

Input Schema

NameRequiredDescriptionDefault
kbIdYesKnowledge-base entry id, from `kb_list`.
valueNotrue attaches, false detaches.
agentIdYesAI agent id, from `agent_list`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations, it discloses the essential post-call workflow (`agent_train`), the permission requirement, and the boundary that this tool does not create or delete knowledge entries. These are meaningful behavioral details that prevent incorrect agent 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 front-loaded with the core purpose and then adds the critical follow-up, scope boundary, and permission requirement in compact sentences. Every sentence carries useful information for invocation.

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 three-parameter mutation tool with full schema coverage and useful annotations, the description covers the important gaps: follow-up training, one-agent scope, non-creation/non-deletion boundaries, and permissions. No output schema exists, so return-value explanation is not required.

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?

Schema description coverage is 100%, so all three parameters are already documented in the schema. The description only reinforces scope and inclusion/exclusion semantics; it does not add parameter-level syntax or edge-case meaning beyond the schema.

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 states a specific verb and resource: include or exclude a knowledge entry for one agent. It also distinguishes the operation from `kb_upsert` creation and deletion behavior, so an agent can tell what this tool does without inspecting the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives the critical follow-up requirement: run `agent_train` afterwards or the change has no effect on answers. It also names the sibling alternative for creating entries (`kb_upsert`), states that this tool neither creates nor deletes, and notes the permission prerequisite.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources