Skip to main content
Glama

projects.register

Register a project with Kontexta to index its markdown files, persist metadata, and link declared tools.

Instructions

Register a new project and link it to the Kontexta knowledge system.

SIDE EFFECTS: Writes project metadata to disk (persisted in the Kontexta data directory). Scans the project root recursively to discover and index all markdown files into the local database. Registers any kontexta.json-declared Hands tools found in the project root. This operation is idempotent — re-registering an existing project updates its metadata without data loss.

AUTH / RATE LIMITS: None. Operates entirely on the local file system.

PARAMETERS:

  • name: Human-readable project name.

  • path: Absolute path to the project root. Required. DO NOT guess or assume the path based on the active editor workspace unless the user explicitly asks to register the "current" or "open" project. If the user provides a project name but no path, ask them for the absolute path before calling this tool. Fails with a descriptive error if the path does not exist or is inaccessible.

  • description: Optional free-text description stored with the project metadata.

RETURNS: A JSON object containing:

  • project: { id, name, path, description, created_at }

  • discovered_files_count: number of markdown files indexed

  • discovered_files: array of { path, est_tokens, size_bytes } for each file

  • total_est_tokens: estimated total token cost of all discovered files

  • hands: { found, tools_registered, tools_disabled, warnings }

  • warnings: array of non-fatal issues (e.g. scan failures, token budget exceeded)

ERROR CONDITIONS: Returns isError=true if path is missing or unresolvable. Scan failures are non-fatal and reported in warnings rather than as errors.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesProject name
pathYesAbsolute path to the project root. Required. DO NOT guess from the active workspace unless asked. Ask the user if unsure.
descriptionNoOptional project description

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv4.7.2

TDQS

A4.7/5.0
Behavior5/5

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

No annotations are provided, so the description carries the full burden, and it does so thoroughly. It discloses side effects (writing metadata to disk, recursive markdown scan, Hands tool registration), idempotence, local-only operation, and the distinction between fatal errors and non-fatal warnings.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well organized with clear sections (SIDE EFFECTS, AUTH/RATE, PARAMETERS, RETURNS, ERROR CONDITIONS) and front-loaded purpose. It is on the longer side, but each section contributes necessary behavioral or usage detail for a complex operation.

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 tool's complexity, the absence of an output schema, and no annotations, this description is remarkably complete. It documents the full return payload, error conditions, idempotency, side effects, and parameter guidance, giving an agent everything needed to invoke the tool correctly and interpret results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Even with 100% schema description coverage, the description adds substantial value beyond the schema: it defines 'path' as required with the strong DO NOT guess directive and instructs the agent to ask the user for the absolute path when only a name is provided. It also clarifies the meaning of 'name' and 'description' with practical context and describes the failure mode for an unresolvable path.

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 states a specific verb and resource: 'Register a new project and link it to the Kontexta knowledge system.' This clearly differentiates it from sibling tools like projects.list and projects.refresh_index. No ambiguity remains about what the tool accomplishes.

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 gives clear context for when to call it and includes explicit guidance about not guessing paths and asking the user for an absolute path. It stops short of explicitly comparing against sibling tools or stating when not to use it, but the use case is unambiguous enough that alternatives are not needed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.