Skip to main content
Glama

add_favorite

Mark a LeafWiki page as a favorite for the authenticated user by page ID or slash-separated path, saving it for quick access.

Instructions

Favorite a page for the authenticated user.

Args: id: Page identifier, preferred when both selectors are supplied. path: Slash-separated page path.

Returns: Serializable favorite confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
pathNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden. It never says whether the operation is idempotent, what happens when the page is already a favorite, whether it requires write permissions, or what errors look like on an unknown id/path. "Serializable favorite confirmation" is vague rather than informative.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded and the text is short, but the Google-style "Args/Returns" block is docstring residue with low value here. The Returns line restates what the output schema already provides.

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

Completeness3/5

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

An output schema exists, so return-value detail is unnecessary, and the two parameters are addressed. For a state-mutating favorite operation with zero annotations, though, the definition stops short of the permission, idempotency, and error context an agent would need.

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 0%, so the description must compensate, and it partially does: it explains that id is the page identifier and that it takes precedence when both selectors are given, and that path is a slash-separated page path. It omits that both are optional (no required fields) and what happens if neither is supplied.

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 opening sentence states a specific verb and resource ("Favorite a page") and scopes it to the authenticated user, which is clear. It does not, however, distinguish itself from the obvious sibling remove_favorite or explain how it relates to list_favorites.

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

Usage Guidelines2/5

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

There is no guidance on when to call this versus remove_favorite or list_favorites, nor any statement of preconditions (does the page need to exist first?). The only hint of selection logic is the preference note between id and path, which is parameter-level, not usage-level.

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