Skip to main content
Glama

Get Project Statistics

get_statistics
Read-onlyIdempotent

Retrieve project-wide statistics: word count, document count, title, and author. Optionally include extended per-category statistics.

Instructions

Return project-wide statistics: total word and document counts, plus title and author. Use this for a quick project overview; use get_structure for the per-document breakdown or get_document_info for a single document. Requires an open project.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
detailedNoInclude extended per-category statistics when available. Default false.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYesProject title (defaults to "Untitled").
authorNoProject author, if set.
metadataYesProject metadata.
totalWordsYesTotal word count across all documents.
lastModifiedYesISO timestamp of when these statistics were generated.
totalFoldersYesNumber of folder items.
draftDocumentsYesNumber of documents in the Draft.
totalDocumentsYesTotal number of items in the project.
documentsByTypeYesCount of documents keyed by type.
longestDocumentNoThe longest document, or null if none.
totalCharactersYesTotal character count across all documents.
documentsByLabelYesCount of documents keyed by label.
recentlyModifiedYesRecently modified documents.
shortestDocumentNoThe shortest document, or null if none.
trashedDocumentsYesNumber of trashed documents.
documentsByStatusYesCount of documents keyed by status.
researchDocumentsYesNumber of documents in Research.
averageDocumentLengthYesAverage word count per text document.
Behavior4/5

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

Annotations already provide readOnlyHint, idempotentHint, destructiveHint. Description adds that it returns specific data and requires open project. No contradictions; sufficient additional context.

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 sentences: first defines output, second gives usage guidance. No waste, front-loaded.

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?

With output schema present and annotation richness, description covers all needed: function, output, usage context, prerequisite, and alternatives.

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?

Only one parameter 'detailed' with full schema description (boolean, default false, includes extended stats). Description adds no extra meaning beyond 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?

Clearly states it returns project-wide statistics (total word and document counts, title, author). Distinguishes from siblings get_structure and get_document_info.

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?

Explicitly says to use for quick project overview, and directs to get_structure for per-document breakdown or get_document_info for single document. Also mentions prerequisite: requires an open project.

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