Skip to main content
Glama
affinity-mcp

affinity-mcp

by StevenJPx2

affinity_list_documents

Read-onlyIdempotent

Lists all documents currently open in Affinity, returning each session UUID, title, file path, and unsaved-change status so you can identify and target the right document.

Instructions

List the documents currently open in Affinity with their session UUIDs, titles, paths, and dirty state.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds real value by enumerating what is returned (session UUIDs, titles, paths, dirty state), which tells the agent this is a discovery/inspection call rather than a content read.

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?

A single front-loaded sentence with no filler. The scope constraint appears first and the returned fields follow, so the agent gets purpose and payload in one pass.

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

Completeness4/5

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

With no output schema present, the description carries the burden of describing return values, and it does so by naming the four returned fields. It omits ordering, whether only frontmost windows appear, and behavior when no documents are open — minor gaps for a zero-parameter list call.

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

Parameters4/5

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

The tool takes zero parameters, so there is nothing for the description to disambiguate; baseline 4 applies. The description correctly does not invent filtering options that the schema does not support.

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 specific verb and resource ('List the documents currently open in Affinity') and qualifies scope with 'currently open', which separates it from affinity_open_document and affinity_new_document. It stops short of naming a sibling explicitly, so differentiation relies on inference from the verb.

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

Usage Guidelines3/5

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

Usage is implied by 'currently open' — an agent can infer this is the inspection call used before acting on a session. However, there is no explicit statement of when to prefer this over affinity_status or affinity_get_document_settings, and no prerequisites or exclusion conditions are given.

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