Skip to main content
Glama

register

Map a repo to a vault project so vault-backed commands auto-detect the slug (writes the vault project-map.json locator; project knowledge stays jailed under projects//).

Instructions

Map a repo to a vault project so vault-backed commands auto-detect the slug (writes the vault project-map.json locator; project knowledge stays jailed under projects//).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "register"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoDirectory to map (default: cwd). Git roots are used as the key.
slugNoExplicit project slug (default: keep existing mapping or derive from directory name)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.13.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false, so the description carries the real disclosure burden and does well: it names the exact artifact written (project-map.json locator) and the scoping behavior (knowledge jailed under projects/<slug>/). It does not mention permissions or reversibility, but adds meaningful context beyond the annotation.

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?

A single sentence, front-loaded with the action and scope, followed by parenthetical side-effect details. Dense but no wasted sentences.

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?

For a two-optional-parameter write tool with no output schema, the description covers purpose, side effect, and scoping. Nothing essential to correct invocation is missing, though permission/auth requirements are unstated.

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?

Schema coverage is 100%, so both parameters are already well documented in the schema with defaults and key derivation. The description adds no syntax or format detail beyond what the schema provides, making the baseline 3 appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Map') and resource ('repo to a vault project') and names the concrete effect (auto-detect the slug). The scope is clear enough to distinguish it from most siblings, though it never names an alternative tool directly.

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

Usage Guidelines3/5

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

The description explains why you would use it ('so vault-backed commands auto-detect the slug'), which implies the use case, but gives no explicit when-to-use vs when-not guidance or named alternatives among siblings like init or link.

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