cozyvtt-mcp

Document List

document_list

Read-onlyIdempotent

List document assets filtered by scope, search, and page. Retrieve read-only results without modifying or consuming files.

Instructions

List document assets with scope, search, and page filters. Use campaign_document_list to discover personal documents shared into this campaign; use document_read for content. Read-only; upstream filters by access. USER restricts to personal assets (including an explicit current-user filter for admins); null scope leaves filtering to upstream. Repeated listing does not consume or modify assets. Returns {ok:true,data} on success; tool-body failures return {ok:false,error} with optional diagnostic data. Argument-schema errors are MCP errors.

Input Schema

TableJSON Schema

Name	Required	Description
`page`	No	One-based page number, integer >=1; defaults to the first page.
`limit`	No	Assets per page, integer 1..100; defaults to 50.
`scope`	No	Optional USER/CAMPAIGN/GLOBAL filter; null leaves scope unspecified. USER means current-user personal assets.
`search`	No	Optional search text passed upstream; null omits the filter, empty text is sent explicitly.
`campaign_id`	No	Explicit campaign ID; null uses the configured campaign when scope=CAMPAIGN, otherwise omits the field. If supplied, it is forwarded for any scope.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Addedv0.3.0Sep 20, 2026

TDQS

A4.9/5.0

Behavior5/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint. The description adds valuable context beyond those: upstream filters by access, USER scope uses an explicit current-user filter for admins, repeated listing does not consume or modify assets, and success/failure return shapes are specified. No contradiction with annotations.

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 front-loaded with purpose and filters, immediately followed by sibling routing, then behavioral notes and return/error semantics. Every sentence adds distinct value; there is no filler or repetition of schema content.

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 5-parameter read-only list tool with an output schema, the description is complete: it covers scope semantics, access filtering, idempotence, success shape, tool-body failure shape, and MCP-level argument errors. Nothing critical is missing for correct invocation.

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?

Schema coverage is 100%, so the baseline is 3. The description adds meaningful param nuance beyond the schema, particularly that USER restricts to personal assets with an explicit current-user filter for admins and that null scope leaves filtering to upstream. This clarifies behavior that raw schema descriptions only hint at.

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 opens with the specific verb 'List' and resource 'document assets', then names the exact filters (scope, search, page). It also explicitly distinguishes itself from campaign_document_list and document_read, so an agent can tell sibling tools apart immediately.

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?

It gives clear routing guidance: use campaign_document_list to discover personal documents shared into the campaign, and use document_read for content. It also explains read-only access and upstream filtering, which helps the agent decide when this tool is appropriate versus alternatives.

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