Skip to main content
Glama

Analyze Document

analyze_document
Read-onlyIdempotent

Analyze the writing quality of a single document to get a summary of readability, pacing, and top issues. Focus on style, structure, themes, characters, sentiment, or pacing.

Instructions

Analyze the writing quality of a single document and return a summary of readability, pacing, and the top issues found. This is the general-purpose prose analyzer: narrow it with analysisTypes to focus on style, structure, themes, characters, sentiment, or pacing. Use check_consistency for project-wide continuity instead, or enhance_content to get rewritten prose rather than a critique. Calls an external AI model. Requires an open project and a valid document id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYesScrivener document UUID, as returned by get_structure (a binder item "id").
analysisTypesNoAspects to focus the analysis on. Omit or use ["all"] for a broad analysis; otherwise pick any of readability, sentiment, themes, characters, pacing, style, structure.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
issuesYesCraft issues found in the document.
pacingYesPacing assessment of the passage (e.g. slow/steady/fast with a brief reason).
readabilityYesReadability assessment of the passage (e.g. easy/moderate/complex with a brief reason).
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive. The description adds that the tool calls an external AI model and requires an open project and valid document ID, providing useful context beyond the 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 four sentences long, front-loaded with the core purpose, and each sentence adds distinct value without redundancy.

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?

Given the low complexity (2 params, output schema exists), the description covers purpose, usage, alternatives, prerequisites, and behavioral traits comprehensively.

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 coverage is 100% so parameters are already documented. The description adds minimal extra value by saying 'narrow it with analysisTypes' and mentioning the requirement for an open project and document ID, but does not significantly enhance parameter understanding beyond the schema.

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 clearly states it analyzes writing quality and returns a summary. It distinguishes from sibling tools by explicitly recommending check_consistency for project-wide continuity and enhance_content for rewritten prose, making the purpose specific and unambiguous.

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 provides explicit when-to-use context (general-purpose prose analyzer) and when-not-to-use with named alternatives (check_consistency, enhance_content). It also explains how to narrow analysis using analysisTypes.

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