Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
DOCS_ROOTYesPath to the alcove docs repository root directory.
ALCOVE_LANGNoOverrides the automatically detected system locale.
MCP_PROJECT_NAMENoOverrides the project name detection from the current working directory.

Capabilities

Features and capabilities supported by this server

CapabilityDetails
tools
{
  "listChanged": false
}

Tools

Functions exposed to the LLM to take actions

NameDescription
get_project_docs_overviewA

List all documentation files for the current project with file sizes and classification labels.

Call this tool first when the user asks what docs exist, wants a summary of project documentation, or before deciding which files to read. It is read-only and has no side effects.

Scans two locations: the alcove doc-repo (private/internal docs) and the project repository root + docs/ (public-facing docs).

Classification labels:

  • doc-repo-required: core internal docs required by policy (e.g. PRD, ARCHITECTURE)

  • doc-repo-supplementary: optional internal extras

  • project-repo: public-facing docs in the project repo (e.g. README, CHANGELOG)

  • reference: reports and reference materials

  • unrecognized: files not matching any known category

Returns an empty list if no docs exist yet. Use init_project to create initial docs.

search_project_docsA

Search documentation files for a keyword or phrase. Automatically uses BM25 ranked search when index is available, falls back to grep (substring match) otherwise.

scope="project" (default): current project only, based on CWD. scope="global": search across ALL projects in the doc repository.

Use global scope when the user:

  • does not specify a project, or says 'all projects', 'everywhere', 'across projects'

  • references previously saved notes, knowledge, or past decisions

  • wants to compare how different projects handle the same topic

  • uses words like 'find everywhere', 'search everything', 'all docs'

  • asks in Korean: '전체', '모든 프로젝트', '다른 프로젝트에서는'

Use project scope (default) when the user asks about the current project context.

get_doc_fileA

Read the full content of a specific documentation file by its relative path.

Use this tool when you know the exact file to read — typically after get_project_docs_overview or search_project_docs has identified the relevant file. It is read-only and has no side effects.

For large files, use offset and limit to read in chunks and avoid exceeding context limits. offset is a character (not line) position. Omit both to read the entire file.

Returns an error if the file does not exist or the path is outside the doc root.

list_projectsA

List all projects that have documentation stored in the alcove doc-repo.

Use this tool when:

  • The user asks which projects are available or tracked in alcove

  • You need to verify a project exists before calling get_project_docs_overview or search_project_docs

  • The user wants to switch project context or compare projects

  • Before using scope="global" in search_project_docs to understand what will be searched

It is read-only and has no side effects. Does not require any parameters.

Returns an array of project names derived from subdirectory names in the alcove doc-repo. Returns an empty array if no projects have been initialized yet — use init_project to create one. Project names are case-sensitive and match the directory names exactly.

audit_projectA

Audit documentation health across both the alcove doc-repo (private/internal) and the project repository (public-facing).

Use this tool when the user wants to know what docs are missing, outdated, or misplaced — for example: 'audit my docs', 'what docs am I missing?', 'check my documentation health'.

Scans two locations:

  1. alcove doc-repo: checks for missing required internal docs

  2. project repo root + docs/: checks for missing public-facing docs

Suggests actions such as generating missing public docs from internal content, or incorporating project repo materials into alcove. NEVER suggests exposing raw internal docs to the project repo.

IMPORTANT: This tool only reports findings. Always present the results to the user and ask which actions to proceed with before calling init_project or configure_project.

configure_projectA

Create or update per-project settings in alcove.toml. Each project can override global defaults for: diagram format, required core docs, team docs, and public docs. Only the fields you specify are changed; unmentioned settings are preserved. Run init_project first if the project does not yet exist.

init_projectA

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.

validate_docsA

Validate the current project's documentation against the team policy defined in policy.toml.

Use this tool when the user asks to check doc quality, run a policy check, or verify docs before a release. It is read-only and does not modify any files.

Checks performed:

  • Required files exist

  • Template placeholders (e.g. TODO, FIXME) have been filled in

  • Required section headings are present

  • Lists meet minimum item counts defined in policy

Returns a pass/warn/fail status per file with specific details about each violation. If no policy.toml exists, returns a message indicating policy is not configured. Use configure_project or init_project to set up policy.

rebuild_indexA

Trigger an incremental index update in the background. Returns immediately — the agent is not blocked while indexing runs. Run this after adding or updating documents. Search results will reflect the new documents once indexing completes.

check_doc_changesA

Check which documentation files have been added, modified, or deleted since the last index build.

Use this tool before search_project_docs when you want to ensure the index is up to date, or when the user asks whether docs have changed recently. It is safe to call at any time — without auto_rebuild it is read-only and has no side effects.

Compares current file timestamps against the stored index metadata. Returns a list of changed files grouped by status: added, modified, deleted.

Set auto_rebuild=true to automatically trigger rebuild_index if any changes are detected, avoiding a separate tool call. If no index exists yet, reports all files as new.

lint_projectA

Lint project documentation for semantic issues: broken links, orphaned files, stale markers (WIP/TODO/FIXME/DRAFT/DEPRECATED), and stale year references.

Use this tool when the user asks to check doc quality beyond policy compliance, find broken internal links, locate TODO/WIP content, or audit doc hygiene.

Checks:

  • broken-link (warning): wikilinks [[target]] or markdown links text that resolve to no file

  • orphan (info): files not linked from any other document (index/readme/moc excluded)

  • stale-marker (warning): files containing WIP, TODO, FIXME, DRAFT, DEPRECATED, DO NOT USE, OUTDATED

  • stale-date (info): files mentioning a year that is 2+ years in the past

Optionally filter by project name. If omitted, scans all projects.

search_vaultA

Search knowledge base vaults for a query. Use this to find information in research notes, reference materials, and curated knowledge bases — separate from project documentation.

list_vaultsA

List all knowledge base vaults with their document counts.

promote_documentA

Promote a document from an external vault (e.g. Obsidian) into the alcove doc-repo.

Use this tool when the user wants to import, migrate, or copy a file from outside alcove into the appropriate project directory.

If 'project' is not specified, the target project is auto-detected by matching the file name and content keywords against known project directory names. Falls back to the 'inbox/' directory if no match is found.

By default, the file is copied (safe). Set copy=false to move it instead.

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription

No resources

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