Skip to main content
Glama

init_project

Initialize documentation for new projects from templates. Creates internal docs (PRD, Architecture) in the doc-repo and external docs like README when a project path is provided.

Instructions

Initialize documentation for a new project from alcove templates. Creates internal docs (PRD, Architecture, etc.) in the alcove doc-repo. When project_path is provided, also creates external docs (README, CHANGELOG, QUICKSTART) in the project repository. Use the 'files' parameter to create only specific documents. Without 'files', creates all missing internal required docs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filesNoSpecific files to create (e.g. ["PRD.md", "ARCHITECTURE.md"]). If omitted, creates all Tier 1 docs.
overwriteNoOverwrite existing files (default: false)
project_nameYesName of the project to initialize docs for
project_pathNoAbsolute path to the project repository (for creating external docs like README)
Behavior5/5

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

Even without annotations, the description fully discloses behavior: it creates files in specific locations, handles missing docs automatically, and respects the overwrite parameter. No contradictions or hidden effects are implied.

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 concise, using three sentences that efficiently convey the tool's purpose, customization options, and behavior. Every sentence adds value without redundancy.

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?

The description covers the main functionality, customization via parameters, and conditional behavior. It lacks details about return values or error handling, but given the tool's complexity and lack of output schema, it is largely complete for an initialization tool.

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%, but the description adds meaningful context beyond the schema: it explains the dual purpose of project_path (external docs) and that omitting 'files' triggers creation of all missing internal required docs. This adds value above the baseline of 3.

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 the tool initializes documentation for a new project using templates, specifying internal (PRD, Architecture) and external (README, CHANGELOG, QUICKSTART) docs. This distinguishes it from sibling tools like lint or validate.

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

Usage Guidelines4/5

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

The description provides explicit context: when project_path is given, external docs are also created; the 'files' parameter selects specific documents; without 'files', all missing internal required docs are created. However, it does not explicitly mention when not to use this tool or suggest alternatives.

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/epicsagas/alcove'

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