obsidian-mcp-server
Version:
MCP server for Obsidian vaults — read, write, search, and surgically edit notes, tags, and frontmatter via the Local REST API plugin. STDIO or Streamable HTTP.
32 lines • 1.54 kB
TypeScript
/**
* @fileoverview obsidian://vault/{+path} — note content as a stable, addressable
* URI. Mirrors `obsidian_get_note` with `format: "full"` for clients that
* support attaching resources to a conversation.
* @module mcp-server/resources/definitions/obsidian-vault-note.resource
*/
import { z } from '@cyanheads/mcp-ts-core';
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
export declare const obsidianVaultNote: import("@cyanheads/mcp-ts-core").ResourceDefinition<z.ZodObject<{
path: z.ZodString;
}, z.core.$strip>, z.ZodObject<{
path: z.ZodString;
content: z.ZodString;
frontmatter: z.ZodRecord<z.ZodString, z.ZodUnknown>;
tags: z.ZodArray<z.ZodString>;
stat: z.ZodObject<{
ctime: z.ZodNumber;
mtime: z.ZodNumber;
size: z.ZodNumber;
}, z.core.$strip>;
}, z.core.$strip>, readonly [{
readonly reason: "path_forbidden";
readonly code: JsonRpcErrorCode.Forbidden;
readonly when: "The requested path is outside OBSIDIAN_READ_PATHS (and OBSIDIAN_WRITE_PATHS, since write paths imply read access).";
readonly recovery: "Use a path inside the configured read scope. The error data echoes the active scope.";
}, {
readonly reason: "note_missing";
readonly code: JsonRpcErrorCode.NotFound;
readonly when: "The vault path does not resolve to an existing note.";
readonly recovery: "Verify the path with obsidian_list_notes or use obsidian_search_notes to locate the note.";
}]>;
//# sourceMappingURL=obsidian-vault-note.resource.d.ts.map