Skip to main content
Glama
christianclaudio

mcp-server-sigma

Workspace Favorite File

workspace_favorite_file

Add a document to a member's favorites.

Instructions

Add a document to a member's favorites.

Input Schema

NameRequiredDescriptionDefault
inode_idYes
member_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.1.0

TDQS

C2.6/5.0
Behavior2/5

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

Annotations already declare this is a non-destructive mutation (readOnlyHint=false, destructiveHint=false), so the safety profile is covered. The description adds nothing beyond the bare action: it does not say whether adding twice is idempotent, whether it errors on an unknown member_id or inode_id, or what permissions are required.

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?

A single short sentence with zero padding, which is good, but the brevity comes at the cost of under-specification rather than deliberate economy. It is front-loaded with the action, which helps.

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?

An output schema exists, so return values need not be described. However, for a mutation tool with two entirely undocumented parameters and no annotations-level detail added, the description leaves an agent guessing about identifier formats and post-call state; it is not complete enough to invoke confidently.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the two parameters (member_id, inode_id) carry no documented meaning in structured data. The description only loosely implies the mapping via the words 'document' and 'member' and gives no format hints, no pointer to workspace_get_file for resolving an inode, and no indication of which identifier namespace is expected.

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?

States a concrete verb ('Add') and resource ('a document to a member's favorites'), so the action is unambiguous. It does not explicitly delimit itself from workspace_unfavorite_file, but the name and description together make the direction of the operation clear.

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?

No guidance on when to use this versus workspace_unfavorite_file, workspace_list_favorites_for_member, or workspace_update_file. There is no mention of preconditions such as the member or document needing to exist, and no note about what happens if the item is already favorited.

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