Skip to main content
Glama

create_or_update_rule

Record patterns, decisions, or changes by creating or updating documentation to keep it current for future agents.

Instructions

Create or update documentation as you discover new patterns, decisions, or changes. Use this to keep docs current for future agents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYesDocument title for display and search
topicsNoOptional topical tags to group related documents
contentYesFull markdown content of the documentation
categoryNoOptional category label for this document
fileNameYesDocumentation file name. Must end with .md. Example: "api-patterns.md"
keywordsNoSearch keywords. Include technologies, patterns, and concepts covered
alwaysApplyNoMark this doc as always-apply guidance for every task
descriptionNoBrief summary of the document's purpose
filePatternsNoOptional file globs for contextual docs. Examples: ["**/*.test.js"]
Behavior2/5

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

With no annotations, the description must disclose behavioral traits. It only mentions 'create or update' (upsert behavior), but lacks details on side effects, idempotency, or what happens on update vs create. The boolean parameter 'alwaysApply' is not explained in description.

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 two sentences, front-loaded with the action, and contains no unnecessary words. It is concise and to the point.

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?

Despite 9 parameters and no output schema, the description does not explain the purpose of rules vs other doc tools, return values, or the effect of fields like 'alwaysApply'. It is incomplete for an agent to understand all aspects of invocation.

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 coverage is 100%, and the description adds no additional semantic meaning beyond the schema. Baseline 3 is appropriate as the description does not compensate with extra context for the parameters.

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 action (create or update) and resource (documentation) with a specific context (discovering patterns, decisions, changes). It distinguishes from sibling tools like 'add_docset' or 'search_documentation' by focusing on individual documentation rules.

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?

Provides clear context for when to use: 'as you discover new patterns, decisions, or changes' and 'to keep docs current for future agents'. No explicit exclusions or alternatives are mentioned, but the context is clear.

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/afterxleep/doc-bot'

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