Skip to main content
Glama

Get Collection

get_collection
Read-onlyIdempotent

Retrieve a specific AFFiNE sidebar collection by its ID, including its rules and allow-list. Use when you need details for a known collection ID.

Instructions

Read one AFFiNE sidebar collection by id, including rules and allow-list. Use list_collections first when the id is unknown.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceIdNoAFFiNE workspace id. Omit only when AFFINE_WORKSPACE_ID is configured.
collectionIdYesAFFiNE collection id from list_collections or create_collection.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameYes
rulesYes
allowListYes
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false. The description adds context about what is included in the result (rules and allow-list) and confirms the read-only, non-destructive nature. This adds value beyond the annotations without contradicting them.

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?

Two efficient sentences: the first states the core action and scope, the second gives a practical prerequisite. No filler or redundancy, and both sentences earn their place.

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 simple read operation with a rich output schema present, the description fully covers what the tool returns, when to use it, and the prerequisite for the id. The output schema handles return-value details, so no additional context is needed.

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%, with both parameters already described in the schema. The description references 'by id' and mentions list_collections for obtaining the id, but does not add further parameter-level semantics. Baseline 3 applies because the schema carries the load.

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 uses a specific verb and resource ('Read one AFFiNE sidebar collection by id') and states the included contents (rules and allow-list). It clearly distinguishes from siblings like list_collections by emphasizing a single collection lookup by id.

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?

Provides explicit guidance: 'Use list_collections first when the id is unknown,' which tells the agent when an alternative tool is appropriate. This is a clear when-to-use and when-not-to-use signal.

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/irfanhak123/affine-mcp-server'

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