obsidian_rest_status
Read-only
Check whether the Obsidian Local REST API bridge is running and ready for use.
Instructions
Check the optional Obsidian Local REST API bridge status.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools.ts:1182-1191 (handler)Handler for the obsidian_rest_status tool. Checks if REST API is configured, returns the URL, and optionally pings the / endpoint if configured.
"obsidian_rest_status", "Check the optional Obsidian Local REST API bridge status.", {}, async () => ({ configured: Boolean(config.restApiKey), url: config.restUrl, response: config.restApiKey ? await obsidianRestRequest(config, { path: "/" }) : undefined, }), { readOnlyHint: true }, ); - src/tools.ts:1182-1185 (schema)The schema/input for obsidian_rest_status is empty ({}) — no parameters needed.
"obsidian_rest_status", "Check the optional Obsidian Local REST API bridge status.", {}, async () => ({ - src/tools.ts:1182-1191 (registration)Registration of the obsidian_rest_status tool via the tool() helper function inside registerObsidianTools().
"obsidian_rest_status", "Check the optional Obsidian Local REST API bridge status.", {}, async () => ({ configured: Boolean(config.restApiKey), url: config.restUrl, response: config.restApiKey ? await obsidianRestRequest(config, { path: "/" }) : undefined, }), { readOnlyHint: true }, ); - src/rest.ts:11-16 (helper)The obsidianRestRequest helper function used by the handler to make the actual HTTP request to the Obsidian Local REST API.
export async function obsidianRestRequest(config: ObsidianMcpConfig, options: RestRequestOptions): Promise<{ status: number; ok: boolean; contentType: string; body: unknown; }> { - src/config.ts:8-23 (helper)Config type defining restUrl and restApiKey fields used to check and configure the REST API bridge status.
export type ObsidianMcpConfig = { vaults: VaultSpec[]; defaultVault: string; readOnly: boolean; enableDelete: boolean; maxSearchResults: number; pretty: boolean; dailyFolder: string; dailyPattern: string; ragCommand: string; restUrl: string; restApiKey?: string; restInsecureTls: boolean; enableCommands: boolean; enableUiOpen: boolean; };