@aniketbiswas/obsidian-mcp-server 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aniket Biswas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,232 @@
+# 🗃️ Obsidian MCP Server
+
+[![MIT License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
+[![MCP](https://img.shields.io/badge/MCP-1.0.0-blue)](https://modelcontextprotocol.io)
+
+Connect AI assistants like **Claude** to your [Obsidian](https://obsidian.md) vault via [Model Context Protocol](https://modelcontextprotocol.io). **40+ tools** for searching, creating, and managing your notes—all 100% local.
+
+---
+
+## What Can You Do?
+
+| You Say | What Happens |
+|---------|--------------|
+| "Search my notes for machine learning" | Searches your entire vault |
+| "Create a meeting note for tomorrow" | Creates a formatted meeting note |
+| "What links to my Projects note?" | Shows all backlinks |
+| "Add to my daily note: finished the API" | Appends to today's daily note |
+| "Find orphan notes" | Lists unconnected notes |
+
+---
+
+## Quick Start
+
+### 1. Install the Obsidian Plugin
+
+1. **Obsidian** → **Settings** → **Community plugins** → **Browse**
+2. Search "**Local REST API**" → **Install** → **Enable**
+3. **Settings** → **Local REST API** → Copy your **API Key**
+
+### 2. Install the MCP Server
+
+**Option A: Install from npm (recommended)**
+
+```bash
+npm install -g @aniketbiswas/obsidian-mcp-server
+```
+
+**Option B: Install from source**
+
+```bash
+git clone https://github.com/aniketbiswas/obsidian-mcp-server.git
+cd obsidian-mcp-server
+npm install && npm run build
+npm link  # Makes it available globally
+```
+
+### 3. Configure Claude Desktop
+
+Edit the config file:
+
+| OS | Config Path |
+|----|-------------|
+| **macOS** | `~/Library/Application Support/Claude/claude_desktop_config.json` |
+| **Windows** | `%APPDATA%\Claude\claude_desktop_config.json` |
+| **Linux** | `~/.config/claude/claude_desktop_config.json` |
+
+**If installed via npm:**
+
+```json
+{
+  "mcpServers": {
+    "obsidian": {
+      "command": "obsidian-mcp-server",
+      "env": {
+        "OBSIDIAN_API_KEY": "your-api-key-here"
+      }
+    }
+  }
+}
+```
+
+**If installed from source:**
+
+```json
+{
+  "mcpServers": {
+    "obsidian": {
+      "command": "node",
+      "args": ["/FULL/PATH/TO/obsidian-mcp-server/build/index.js"],
+      "env": {
+        "OBSIDIAN_API_KEY": "your-api-key-here"
+      }
+    }
+  }
+}
+```
+
+> **Windows paths:** Use `C:\\Users\\Name\\...` or `C:/Users/Name/...`
+
+### 4. Restart Claude Desktop
+
+Make sure Obsidian is running, then try: *"Show me my vault status"*
+
+---
+
+## Available Tools
+
+<details>
+<summary><strong>📁 Vault (6)</strong> — Status, list files, structure</summary>
+
+`vault_status` · `list_files` · `list_all_files` · `get_vault_structure` · `get_file_stats` · `delete_file`
+</details>
+
+<details>
+<summary><strong>📝 Notes (9)</strong> — CRUD operations</summary>
+
+`read_note` · `create_note` · `update_note` · `append_to_note` · `prepend_to_note` · `insert_under_heading` · `replace_in_note` · `delete_note` · `copy_note`
+</details>
+
+<details>
+<summary><strong>🔍 Search (7)</strong> — Full-text, tags, folders</summary>
+
+`search_notes` · `simple_search` · `search_by_tag` · `search_in_folder` · `find_notes_by_name` · `get_recent_notes` · `search_with_context`
+</details>
+
+<details>
+<summary><strong>📊 Metadata (8)</strong> — Frontmatter & tags</summary>
+
+`get_frontmatter` · `update_frontmatter` · `set_frontmatter_property` · `get_tags` · `add_tags` · `remove_tags` · `add_aliases` · `get_all_tags_in_vault`
+</details>
+
+<details>
+<summary><strong>🧭 Navigation (6)</strong> — Open notes, run commands</summary>
+
+`open_note` · `get_active_note` · `append_to_active_note` · `get_commands` · `execute_command` · `quick_capture`
+</details>
+
+<details>
+<summary><strong>📅 Daily Notes (6)</strong> — Journals & standups</summary>
+
+`get_daily_note` · `append_to_daily_note` · `get_periodic_note` · `append_to_periodic_note` · `daily_journal_entry` · `daily_standup`
+</details>
+
+<details>
+<summary><strong>🔗 Links (6)</strong> — Backlinks, orphans, graph</summary>
+
+`get_outgoing_links` · `get_backlinks` · `find_broken_links` · `find_orphan_notes` · `add_link_to_note` · `get_link_graph_data`
+</details>
+
+<details>
+<summary><strong>📋 Templates (4)</strong> — Meeting, project, etc.</summary>
+
+`create_note_from_template` · `create_meeting_note` · `create_project_note` · `list_templates`
+
+Built-in: `meeting` · `project` · `book` · `article` · `person` · `recipe` · `decision`
+</details>
+
+---
+
+## Configuration
+
+| Variable | Required | Default | Description |
+|----------|:--------:|---------|-------------|
+| `OBSIDIAN_API_KEY` | ✅ | — | From Local REST API plugin |
+| `OBSIDIAN_HOST` | | `127.0.0.1` | API host |
+| `OBSIDIAN_PORT` | | `27124` | API port |
+| `OBSIDIAN_SECURE` | | `true` | Use HTTPS |
+| `OBSIDIAN_VERIFY_SSL` | | `false` | Verify SSL certificate |
+
+---
+
+## Troubleshooting
+
+<details>
+<summary><strong>Claude doesn't see the server</strong></summary>
+
+- Validate JSON: `cat config.json | python3 -m json.tool`
+- Path must be **absolute** (starts with `/` or `C:\`)
+- Restart Claude Desktop completely (Cmd+Q / right-click quit)
+- Windows: ensure file is `.json` not `.json.txt`
+</details>
+
+<details>
+<summary><strong>Connection errors</strong></summary>
+
+- Obsidian must be running with Local REST API enabled
+- Test API: `curl -k https://127.0.0.1:27124/ -H "Authorization: Bearer YOUR_KEY"`
+- Regenerate API key if needed
+</details>
+
+<details>
+<summary><strong>Windows: "node not recognized"</strong></summary>
+
+Use full path: `"command": "C:\\Program Files\\nodejs\\node.exe"`
+</details>
+
+---
+
+## Development
+
+```bash
+npm run build      # Compile TypeScript
+npm run dev        # Watch mode
+npm run inspector  # Test tools in browser UI
+```
+
+### Adding Tools
+
+Create/edit files in `src/tools/`, then rebuild:
+
+```typescript
+server.tool("my_tool", "Description", { param: z.string() }, async ({ param }) => {
+  return { content: [{ type: "text", text: "Result" }] };
+});
+```
+
+---
+
+## FAQ
+
+**Is it free?** Yes, the Local REST API plugin is free.
+
+**Are my notes sent to the cloud?** No. Everything stays local. Only your conversation with Claude goes to Anthropic (like any Claude chat).
+
+**Works with Obsidian Sync?** Yes, it accesses your local vault files.
+
+---
+
+## Contributing
+
+PRs welcome! Fork → create branch → commit → open PR.
+
+---
+
+## License
+
+MIT — see [LICENSE](LICENSE)
+
+---
+
+Built with [MCP SDK](https://modelcontextprotocol.io) · Powered by [Local REST API](https://github.com/coddingtonbear/obsidian-local-rest-api)

package/build/index.d.ts

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+/**
+ * ============================================================================
+ * OBSIDIAN MCP SERVER - Main Entry Point
+ * ============================================================================
+ *
+ * An MCP (Model Context Protocol) server for integrating AI assistants with
+ * Obsidian via the Local REST API plugin.
+ *
+ * PREREQUISITES:
+ * 1. Install "Local REST API" plugin in Obsidian
+ * 2. Enable the plugin and note your API key
+ * 3. Set OBSIDIAN_API_KEY environment variable
+ *
+ * FEATURES:
+ * - 40+ tools for vault management, note CRUD, search, and more
+ * - Daily notes and periodic notes support
+ * - Frontmatter/metadata management
+ * - Link analysis and graph operations
+ * - Note templates and quick capture
+ *
+ * For more information: https://modelcontextprotocol.io
+ * ============================================================================
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;;;;;;;;;;;;;GAsBG"}

package/build/index.js

@@ -0,0 +1,148 @@
+#!/usr/bin/env node
+/**
+ * ============================================================================
+ * OBSIDIAN MCP SERVER - Main Entry Point
+ * ============================================================================
+ *
+ * An MCP (Model Context Protocol) server for integrating AI assistants with
+ * Obsidian via the Local REST API plugin.
+ *
+ * PREREQUISITES:
+ * 1. Install "Local REST API" plugin in Obsidian
+ * 2. Enable the plugin and note your API key
+ * 3. Set OBSIDIAN_API_KEY environment variable
+ *
+ * FEATURES:
+ * - 40+ tools for vault management, note CRUD, search, and more
+ * - Daily notes and periodic notes support
+ * - Frontmatter/metadata management
+ * - Link analysis and graph operations
+ * - Note templates and quick capture
+ *
+ * For more information: https://modelcontextprotocol.io
+ * ============================================================================
+ */
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+import { dirname, join } from "path";
+// Get package version for CLI
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const packageJsonPath = join(__dirname, "..", "package.json");
+// Handle CLI arguments
+const args = process.argv.slice(2);
+if (args.includes("--help") || args.includes("-h")) {
+    console.log(`
+Obsidian MCP Server - Connect AI assistants to your Obsidian vault
+
+USAGE:
+  obsidian-mcp-server [options]
+
+OPTIONS:
+  -h, --help      Show this help message
+  -v, --version   Show version number
+
+ENVIRONMENT VARIABLES:
+  OBSIDIAN_API_KEY     (Required) Your Local REST API key
+  OBSIDIAN_HOST        API host (default: 127.0.0.1)  
+  OBSIDIAN_PORT        API port (default: 27124)
+  OBSIDIAN_SECURE      Use HTTPS (default: true)
+  OBSIDIAN_VERIFY_SSL  Verify SSL certificate (default: false)
+
+SETUP:
+  1. Install "Local REST API" plugin in Obsidian
+  2. Copy your API key from plugin settings
+  3. Set OBSIDIAN_API_KEY environment variable
+  4. Add to your Claude Desktop config:
+
+     {
+       "mcpServers": {
+         "obsidian": {
+           "command": "obsidian-mcp-server",
+           "env": { "OBSIDIAN_API_KEY": "your-key-here" }
+         }
+       }
+     }
+
+For more info: https://github.com/aniketbiswas/obsidian-mcp-server
+`);
+    process.exit(0);
+}
+if (args.includes("--version") || args.includes("-v")) {
+    try {
+        const pkg = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+        console.log(`obsidian-mcp-server v${pkg.version}`);
+    }
+    catch {
+        console.log("obsidian-mcp-server v1.0.0");
+    }
+    process.exit(0);
+}
+// Obsidian MCP components
+import { registerAllTools } from "./tools/index.js";
+import { registerObsidianResources } from "./resources/obsidian.js";
+import { registerObsidianPrompts } from "./prompts/obsidian.js";
+// Configuration and client
+import { getConfig } from "./utils/config.js";
+import { ObsidianClient } from "./utils/client.js";
+/**
+ * Create the MCP server instance.
+ */
+const server = new McpServer({
+    name: "obsidian-mcp-server",
+    version: "1.0.0",
+});
+/**
+ * Main function - initializes and starts the MCP server.
+ */
+async function main() {
+    // Validate configuration on startup
+    let client = null;
+    try {
+        const config = getConfig();
+        client = new ObsidianClient(config);
+        console.error(`📂 Obsidian MCP Server starting...`);
+        console.error(`   Host: ${config.host}:${config.port}`);
+        console.error(`   Secure: ${config.secure}`);
+    }
+    catch (error) {
+        console.error("⚠️  Configuration warning:", error.message);
+        console.error("");
+        console.error("Running in demo mode - tools will be visible but won't connect to Obsidian.");
+        console.error("To enable full functionality, set:");
+        console.error("  OBSIDIAN_API_KEY - Your Local REST API key (required)");
+        console.error("");
+        // Create a dummy client for demo mode
+        const dummyConfig = {
+            apiKey: "demo-mode",
+            host: "127.0.0.1",
+            port: 27124,
+            secure: true,
+            timeout: 30000,
+            verifySsl: false,
+        };
+        client = new ObsidianClient(dummyConfig);
+    }
+    // Register all Obsidian tools
+    registerAllTools(server, client);
+    // Register resources
+    registerObsidianResources(server, client);
+    // Register prompts
+    registerObsidianPrompts(server);
+    // Start the server
+    const transport = new StdioServerTransport();
+    await server.connect(transport);
+    console.error("✅ Obsidian MCP Server is running!");
+    console.error("   Tools: 40+ available");
+    console.error("   Resources: 3 available");
+    console.error("   Prompts: 8 available");
+    console.error("");
+    console.error("   Use 'npm run inspector' to test your tools.");
+}
+main().catch((error) => {
+    console.error("❌ Fatal error:", error);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAErC,8BAA8B;AAC9B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACtC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;AAE9D,uBAAuB;AACvB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEnC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IACnD,OAAO,CAAC,GAAG,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCb,CAAC,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IACtD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/D,OAAO,CAAC,GAAG,CAAC,wBAAwB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,0BAA0B;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,2BAA2B;AAC3B,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;IAC3B,IAAI,EAAE,qBAAqB;IAC3B,OAAO,EAAE,OAAO;CACjB,CAAC,CAAC;AAEH;;GAEG;AACH,KAAK,UAAU,IAAI;IACjB,oCAAoC;IACpC,IAAI,MAAM,GAA0B,IAAI,CAAC;IACzC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;QAC3B,MAAM,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACpD,OAAO,CAAC,KAAK,CAAC,YAAY,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACxD,OAAO,CAAC,KAAK,CAAC,cAAc,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAG,KAAe,CAAC,OAAO,CAAC,CAAC;QACtE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAC;QAC7F,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACpD,OAAO,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;QACzE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClB,sCAAsC;QACtC,MAAM,WAAW,GAAG;YAClB,MAAM,EAAE,WAAW;YACnB,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,KAAK;YACd,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,MAAM,GAAG,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,8BAA8B;IAC9B,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,qBAAqB;IACrB,yBAAyB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE1C,mBAAmB;IACnB,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAEhC,mBAAmB;IACnB,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAEhC,OAAO,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACnD,OAAO,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACzC,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC3C,OAAO,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACzC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAClB,OAAO,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;AAClE,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;IACvC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/build/prompts/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * ============================================================================
+ * MCP PROMPTS - Pre-built Templates for AI Interactions
+ * ============================================================================
+ *
+ * Prompts are pre-written templates that help structure interactions.
+ * They're like "shortcuts" - instead of typing a long prompt, users can
+ * select a prompt and fill in a few parameters.
+ *
+ * WHEN TO USE PROMPTS:
+ * - Common tasks users do repeatedly
+ * - Complex prompts that are hard to type from scratch
+ * - Standardized workflows (code review, documentation, etc.)
+ *
+ * ANATOMY OF A PROMPT:
+ *
+ *   server.prompt(
+ *     "prompt-name",             // Unique identifier
+ *     "Description",             // What this prompt does
+ *     { parameters },            // User inputs (using Zod)
+ *     async (inputs) => {}       // Returns the formatted message(s)
+ *   );
+ *
+ * NOTE: Prompts are optional! Many MCP servers only have tools.
+ * ============================================================================
+ */
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+/**
+ * Registers example prompts.
+ * Delete or modify these - they're just examples!
+ */
+export declare function registerPrompts(server: McpServer): void;
+//# sourceMappingURL=index.d.ts.map

package/build/prompts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/prompts/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAGpE;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAmJvD"}

package/build/prompts/index.js

@@ -0,0 +1,152 @@
+/**
+ * ============================================================================
+ * MCP PROMPTS - Pre-built Templates for AI Interactions
+ * ============================================================================
+ *
+ * Prompts are pre-written templates that help structure interactions.
+ * They're like "shortcuts" - instead of typing a long prompt, users can
+ * select a prompt and fill in a few parameters.
+ *
+ * WHEN TO USE PROMPTS:
+ * - Common tasks users do repeatedly
+ * - Complex prompts that are hard to type from scratch
+ * - Standardized workflows (code review, documentation, etc.)
+ *
+ * ANATOMY OF A PROMPT:
+ *
+ *   server.prompt(
+ *     "prompt-name",             // Unique identifier
+ *     "Description",             // What this prompt does
+ *     { parameters },            // User inputs (using Zod)
+ *     async (inputs) => {}       // Returns the formatted message(s)
+ *   );
+ *
+ * NOTE: Prompts are optional! Many MCP servers only have tools.
+ * ============================================================================
+ */
+import { z } from "zod";
+/**
+ * Registers example prompts.
+ * Delete or modify these - they're just examples!
+ */
+export function registerPrompts(server) {
+    // ---------------------------------------------------------------------------
+    // PROMPT: code-review
+    // ---------------------------------------------------------------------------
+    // Takes code and returns a structured code review request.
+    // Demonstrates basic prompt with string and optional parameters.
+    // ---------------------------------------------------------------------------
+    server.prompt("code-review", "Generate a code review for the provided code", {
+        code: z.string().describe("The code to review"),
+        language: z.string().optional().describe("Programming language (e.g., 'typescript', 'python')"),
+    }, async ({ code, language }) => ({
+        // Return an array of messages that form the prompt
+        messages: [
+            {
+                role: "user",
+                content: {
+                    type: "text",
+                    text: `Please review the following ${language || "code"} and provide feedback on:
+1. Code quality and best practices
+2. Potential bugs or issues
+3. Performance considerations
+4. Suggestions for improvement
+
+Code to review:
+\`\`\`${language || ""}
+${code}
+\`\`\``,
+                },
+            },
+        ],
+    }));
+    // ---------------------------------------------------------------------------
+    // PROMPT: explain-code
+    // ---------------------------------------------------------------------------
+    // Simple prompt with just one required parameter.
+    // ---------------------------------------------------------------------------
+    server.prompt("explain-code", "Explain what the provided code does", {
+        code: z.string().describe("The code to explain"),
+    }, async ({ code }) => ({
+        messages: [
+            {
+                role: "user",
+                content: {
+                    type: "text",
+                    text: `Please explain what the following code does in simple terms. Break it down step by step:
+
+\`\`\`
+${code}
+\`\`\``,
+                },
+            },
+        ],
+    }));
+    // ---------------------------------------------------------------------------
+    // PROMPT: generate-docs
+    // ---------------------------------------------------------------------------
+    // Demonstrates using z.enum() for a fixed set of choices.
+    // ---------------------------------------------------------------------------
+    server.prompt("generate-docs", "Generate documentation for the provided code", {
+        code: z.string().describe("The code to document"),
+        style: z
+            .enum(["jsdoc", "markdown", "readme"])
+            .optional()
+            .default("jsdoc")
+            .describe("Documentation style"),
+    }, async ({ code, style }) => ({
+        messages: [
+            {
+                role: "user",
+                content: {
+                    type: "text",
+                    text: `Please generate ${style || "jsdoc"} documentation for the following code:
+
+\`\`\`
+${code}
+\`\`\`
+
+Make sure to include:
+- Description of what the code does
+- Parameter descriptions (if applicable)
+- Return value description (if applicable)
+- Usage examples`,
+                },
+            },
+        ],
+    }));
+    // ---------------------------------------------------------------------------
+    // PROMPT: debug-help
+    // ---------------------------------------------------------------------------
+    // Multiple required parameters for a debugging assistant.
+    // ---------------------------------------------------------------------------
+    server.prompt("debug-help", "Help debug an issue with the provided code and error", {
+        code: z.string().describe("The code with the bug"),
+        error: z.string().describe("The error message or unexpected behavior"),
+    }, async ({ code, error }) => ({
+        messages: [
+            {
+                role: "user",
+                content: {
+                    type: "text",
+                    text: `I'm encountering an issue with my code. Please help me debug it.
+
+**Error/Issue:**
+${error}
+
+**Code:**
+\`\`\`
+${code}
+\`\`\`
+
+Please:
+1. Identify the likely cause of the issue
+2. Explain why it's happening
+3. Provide a fix or solution
+4. Suggest how to prevent similar issues in the future`,
+                },
+            },
+        ],
+    }));
+}
+//# sourceMappingURL=index.js.map

package/build/prompts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/prompts/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,MAAiB;IAE/C,8EAA8E;IAC9E,sBAAsB;IACtB,8EAA8E;IAC9E,2DAA2D;IAC3D,iEAAiE;IACjE,8EAA8E;IAE9E,MAAM,CAAC,MAAM,CACX,aAAa,EACb,8CAA8C,EAC9C;QACE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;QAC/C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qDAAqD,CAAC;KAChG,EACD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QAC7B,mDAAmD;QACnD,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE;oBACP,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,+BAA+B,QAAQ,IAAI,MAAM;;;;;;;QAO3D,QAAQ,IAAI,EAAE;EACpB,IAAI;OACC;iBACI;aACF;SACF;KACF,CAAC,CACH,CAAC;IAEF,8EAA8E;IAC9E,uBAAuB;IACvB,8EAA8E;IAC9E,kDAAkD;IAClD,8EAA8E;IAE9E,MAAM,CAAC,MAAM,CACX,cAAc,EACd,qCAAqC,EACrC;QACE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;KACjD,EACD,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QACnB,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE;oBACP,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE;;;EAGhB,IAAI;OACC;iBACI;aACF;SACF;KACF,CAAC,CACH,CAAC;IAEF,8EAA8E;IAC9E,wBAAwB;IACxB,8EAA8E;IAC9E,0DAA0D;IAC1D,8EAA8E;IAE9E,MAAM,CAAC,MAAM,CACX,eAAe,EACf,8CAA8C,EAC9C;QACE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;QACjD,KAAK,EAAE,CAAC;aACL,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;aACrC,QAAQ,EAAE;aACV,OAAO,CAAC,OAAO,CAAC;aAChB,QAAQ,CAAC,qBAAqB,CAAC;KACnC,EACD,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1B,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE;oBACP,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,mBAAmB,KAAK,IAAI,OAAO;;;EAGnD,IAAI;;;;;;;iBAOW;iBACN;aACF;SACF;KACF,CAAC,CACH,CAAC;IAEF,8EAA8E;IAC9E,qBAAqB;IACrB,8EAA8E;IAC9E,0DAA0D;IAC1D,8EAA8E;IAE9E,MAAM,CAAC,MAAM,CACX,YAAY,EACZ,sDAAsD,EACtD;QACE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;QAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,0CAA0C,CAAC;KACvE,EACD,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1B,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE;oBACP,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE;;;EAGhB,KAAK;;;;EAIL,IAAI;;;;;;;uDAOiD;iBAC5C;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC"}

package/build/prompts/obsidian.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ============================================================================
+ * OBSIDIAN MCP - Prompts
+ * ============================================================================
+ *
+ * Pre-built prompt templates for common Obsidian workflows.
+ * These help users quickly perform complex operations with their vault.
+ * ============================================================================
+ */
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+/**
+ * Register Obsidian prompts with the MCP server.
+ *
+ * @param server - The MCP server instance
+ */
+export declare function registerObsidianPrompts(server: McpServer): void;
+//# sourceMappingURL=obsidian.d.ts.map

package/build/prompts/obsidian.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"obsidian.d.ts","sourceRoot":"","sources":["../../src/prompts/obsidian.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAGpE;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CA+V/D"}