Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
HIAI_DOCS_URLYes
HIAI_DOCS_API_KEYYes

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

This server publishes no instructions, or was last inspected before Glama recorded them.

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{
  "listChanged": true
}
prompts
{
  "listChanged": true
}
resources
{
  "listChanged": true
}

Tools

Functions exposed to the LLM to take actions

NameDescription
find_documentsA

Find readable documents in the active scope. Use mode=list for paginated browsing by folder or tag UUID; use mode=search for hybrid text and semantic retrieval with tag names.

read_documentA

Read one document by UUID. Choose detail for content and metadata, markdown for portable export, or versions for saved revisions and snapshots. All views are read-only.

save_documentA

Create or update one document. Use action=create for a new document or action=update for an existing one; batch_documents handles the same placement change across multiple existing documents. Creation requires write access; content edits require edit access, and placement changes may require write access. Content or placement changes queue normal indexing.

delete_documentA

Move one document to trash without purging content or versions. Use batch_documents(action=trash) for multiple explicit IDs. Requires write access and an explicit delete request; permanently_delete_document is a separate irreversible action.

list_workspace_structureA

List visible folders, categories, or tags in the active workspace or category scope. Set kind=folders to inspect root folders or children of parentId.

save_folderA

Create or update a folder. action=update can rename or move an existing folder; the API enforces category boundaries and queues affected documents for reindexing.

delete_folderA

Delete a folder while preserving its documents; child folders and documents are detached under the API rules. Requires write access.

save_categoryA

Create or update a workspace category. Full workspace write access is required; category-scoped credentials cannot manage categories.

delete_categoryA

Delete a workspace category and detach its documents without deleting them. Requires full workspace write access; category-scoped credentials are denied.

save_tagA

Create or update a workspace tag. Full workspace write access is required; renaming or recoloring a tag causes affected documents to be reindexed.

delete_tagA

Delete a workspace tag and remove its document assignments. Full workspace write access is required; documents themselves remain.

set_document_tagA

Add or remove an existing tag assignment on one document. Use batch_documents for the same tag action across multiple explicit IDs. Requires edit access to each document; action=remove preserves the tag itself.

create_snapshotA

Save a named snapshot of an existing document before a planned change. The snapshot can later be restored with restore_document_version.

restore_document_versionA

Restore content from a version or snapshot listed by read_document(view=versions). This changes current content and queues indexing; it does not restore a trashed document.

explore_graphA

Explore graph relations from readable seed documents. mode=neighbors traverses one document without a query; mode=search ranks relations from one or more seed IDs with optional query text.

get_document_index_statusA

Read current indexing and pipeline status for one document without starting work. Use refresh_document_index only when an explicit retry is intended.

refresh_document_indexA

Queue an explicit asynchronous reindex for one document; use batch_documents(action=refresh_index) for multiple explicit IDs. Routine content and placement changes already schedule indexing; check get_document_index_status first.

list_trashA

List soft-deleted documents visible to the active workspace or category scope. Requires read access and does not restore or purge anything.

restore_trashed_documentA

Return one document from trash to the active library; use batch_documents(action=restore) for multiple explicit IDs. This restores the document itself, unlike restore_document_version which changes content.

permanently_delete_documentA

Irreversibly purge a document already in trash, including its version history. Use only on an explicit user request after checking list_trash.

batch_documentsA

Use for multiple explicitly selected documents that need the same action; for one document prefer the matching single-document tool. Accepts 1–25 IDs for automation compatibility. Supports move, set_category, add_tag, remove_tag, trash, restore, or refresh_index. Processes sequentially through the existing API with a permission check per document and a per-ID result; partial success is possible. Stops after authentication or rate-limit failure. Never expands a search result or permanently purges documents; version restore is separate.

get_workspace_itemA

Read one visible folder, category, or tag by UUID. Folder uses its direct API getter; category and tag lookup uses the complete permission-filtered lists. An absent or out-of-scope ID is reported as not found. Use list_workspace_structure to discover IDs first.

Prompts

Interactive templates invoked by user choice

NameDescription
organize_workspacePlan safe document organization using DocsMint categories and folders.
research_workspaceResearch a question with hybrid search and GraphRAG while citing DocsMint document IDs.

Resources

Contextual data attached and managed by the client

NameDescription
editor-guide
search-guide
workspace-catalog

TDQS

A4.2/5.0

Scored across 22 tools

Disambiguation5/5

Descriptions explicitly delineate boundaries between easily confused pairs (restore_trashed_document vs restore_document_version, delete_document vs permanently_delete_document, refresh_document_index vs get_document_index_status), and each save_*/delete_* tool targets a distinct resource (document, folder, category, tag). Batch vs single-document tools are clearly separated with guidance on when to use each.

Naming Consistency5/5

Nearly every tool follows a predictable snake_case verb_noun pattern (save_document, delete_folder, read_document, list_trash, explore_graph). The single adverb modifier in permanently_delete_document is still readable and consistent with the domain vocabulary.

Tool Count4/5

22 tools is on the heavier side, but the breadth of resources (documents, folders, categories, tags, versions, snapshots, index, graph, trash) justifies most of them. Each tool maps to a real operation, though the save/delete pairs for three resource types inflate the count somewhat.

Completeness5/5

The surface covers the full lifecycle: create/update/read/find, soft-delete, restore, and irreversible purge, plus version and snapshot management, folder/category/tag CRUD, indexing status, graph exploration, and batch operations. No obvious dead ends for the document-management domain.

Maintenance

ActivityActive
ResponsivenessNo issues