Skip to main content
Glama

Queue Project Analysis

queue_project_analysis

Start a background batch analysis to process multiple documents from a project at once, then track progress or cancel as needed.

Instructions

Enqueue a background batch analysis across many documents at once and return a job id immediately. Poll progress with get_job_status and stop it with cancel_job. Use this to analyze a whole manuscript or large set of documents; for a single document prefer queue_document_analysis or the synchronous analyze_document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
optionsNoOptional batch execution settings.
documentsYesArray of documents (id and content) to include in the batch analysis.
projectIdYesIdentifier of the project the documents belong to.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
jobIdYesIdentifier of the queued batch job; poll it with get_job_status.
Behavior4/5

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

Annotations (readOnlyHint=false, destructiveHint=false) indicate it's a write operation that is not destructive. The description adds key behavioral context: it enqueues a background job and returns a job ID immediately, implying asynchronous processing. It references polling and cancellation, which informs the agent about the lifecycle. One could argue it could mention potential errors or resource limits, but overall it's sufficient.

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 very concise: three sentences with no fluff. The first sentence states the core action, the second provides lifecycle context (polling/stopping), and the third gives usage guidance with alternatives. Every sentence earns its place.

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?

Given the complexity (3 params, nested objects, output schema exists), the description covers the core purpose, usage guidance, and lifecycle. It does not explain the output schema or return values, but since an output schema is provided separately, that is acceptable. It might lack error handling details, but overall it is complete enough for an agent to select and invoke the tool correctly.

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%, so the baseline is 3. The description does not add new details about the parameters beyond what the schema already provides. It frames the 'documents' param in the context of 'many documents' and mentions 'batch analysis', but this adds only marginal semantic value beyond the schema's descriptions.

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 starts with a clear, specific verb ('Enqueue a background batch analysis') and resource ('many documents'). It explicitly distinguishes itself from sibling tools by mentioning alternatives for single documents (queue_document_analysis and analyze_document).

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?

The description provides explicit guidance on when to use: 'Use this to analyze a whole manuscript or large set of documents; for a single document prefer queue_document_analysis or the synchronous analyze_document.' It also tells how to monitor and cancel the job, directing to get_job_status and cancel_job.

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/writerslogic/scrivener-mcp'

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