Skip to main content
Glama
jagoff

obsidian-mcp-complete

by jagoff

obsidian_list_vaults

Read-only

List all configured Obsidian vaults to see their names and locations.

Instructions

List configured Obsidian vaults.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Tool registration and handler for obsidian_list_vaults. The handler calls vaults.listVaults() and maps each vault to {name, root, default}.
    tool(
      "obsidian_list_vaults",
      "List configured Obsidian vaults.",
      {},
      () => vaults.listVaults().map((vault) => ({ name: vault.name, root: vault.root, default: vault.name === config.defaultVault })),
      { readOnlyHint: true },
    );
  • VaultManager.listVaults() - returns an array of ResolvedVault objects from the internal vaults map.
    listVaults(): ResolvedVault[] {
      return [...this.vaults.values()];
    }
  • Empty Zod schema for obsidian_list_vaults (no input parameters required).
    {},
  • src/index.ts:23-24 (registration)
    registerObsidianTools(server, vaults, config) is called to register all tools including obsidian_list_vaults.
    registerObsidianResources(server, vaults, config);
    registerObsidianTools(server, vaults, config);
  • VaultSpec type definition used by listVaults return type (via ResolvedVault).
    export type VaultSpec = {
      name: string;
      root: string;
    };
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the description doesn't need to disclose safety. However, it adds no extra behavioral context (e.g., what 'configured' means or how vaults are listed). Adequate for a straightforward read-only tool.

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?

Four words, no fluff, front-loaded with the purpose. Every word earns its place.

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 parameterless, read-only tool with clear annotations, the description provides enough context. Could mention return format, but it's sufficient for the task.

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?

The input schema has no parameters, so schema coverage is 100%. Description adds no parameter info, but none is needed. Baseline 4 applies.

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 verb 'list' and the resource 'configured Obsidian vaults', distinctly identifying the tool's purpose among siblings.

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?

No explicit when-to-use or when-not-to-use guidance is provided. The usage is implied by the tool's simple listing nature, but alternatives like vault_stats or vault_suggest are not mentioned.

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/jagoff/obsidian-mcp'

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