diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 339454e..13a3bae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,7 +98,7 @@ Once a release is shipped and field-tested, submit a PR to [`obsidianmd/obsidian ```json { "id": "mcp-vault-bridge", - "name": "Obsidian MCP", + "name": "MCP Vault Bridge", "author": "allexcd", "description": "Read-only, exclusion-based local bridge for using an Obsidian vault through MCP clients.", "repo": "allexcd/obsidian-mcp" diff --git a/README.md b/README.md index ac225b6..4cde0bc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Obsidian MCP +# MCP Vault Bridge [![CI](https://github.com/allexcd/obsidian-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/allexcd/obsidian-mcp/actions/workflows/ci.yml) [![Release](https://github.com/allexcd/obsidian-mcp/actions/workflows/tag-release.yml/badge.svg)](https://github.com/allexcd/obsidian-mcp/actions/workflows/tag-release.yml) @@ -28,7 +28,7 @@ Vault content returned by MCP tools may be forwarded to the model by the host. C ```text Your Vault/.obsidian/plugins/mcp-vault-bridge/ ``` -3. Restart Obsidian (or reload community plugins) and enable **Obsidian MCP**. +3. Restart Obsidian (or reload community plugins) and enable **MCP Vault Bridge**. 4. Open the plugin settings, click **Check runtime**, then **Install SQLite runtime**. > Node.js 20+ and npm must be available for the runtime install step. If they are missing the settings screen will say so. diff --git a/manifest.json b/manifest.json index 1294fb5..34af787 100644 --- a/manifest.json +++ b/manifest.json @@ -1,6 +1,6 @@ { "id": "mcp-vault-bridge", - "name": "Obsidian MCP", + "name": "MCP Vault Bridge", "version": "0.3.0", "minAppVersion": "1.8.0", "description": "Read-only, exclusion-based local bridge for using an Obsidian vault through MCP clients.", diff --git a/packages/mcp-server/src/config.ts b/packages/mcp-server/src/config.ts index de83cbf..0a9ddc2 100644 --- a/packages/mcp-server/src/config.ts +++ b/packages/mcp-server/src/config.ts @@ -47,7 +47,7 @@ export async function resolveRuntimeConfig(config: ServerConfig, bridge: BridgeC const dbPath = status.pluginDirectory.defaultDatabasePath; if (!dbPath) { throw new Error( - "Could not discover the Obsidian plugin folder for SQLite storage. Keep Obsidian open on desktop, enable the Obsidian MCP plugin, or set OBSIDIAN_MCP_DB explicitly." + "Could not discover the Obsidian plugin folder for SQLite storage. Keep Obsidian open on desktop, enable the MCP Vault Bridge plugin, or set OBSIDIAN_MCP_DB explicitly." ); } diff --git a/packages/mcp-server/src/database.ts b/packages/mcp-server/src/database.ts index 3f39771..77b1962 100644 --- a/packages/mcp-server/src/database.ts +++ b/packages/mcp-server/src/database.ts @@ -358,7 +358,7 @@ function loadBetterSqlite3(): typeof Database { } catch (error) { if (isModuleNotFoundError(error)) { throw new Error( - "SQLite runtime dependency better-sqlite3 is not installed. Open Obsidian MCP plugin settings, click Check runtime, then click Install SQLite runtime. After installation, restart or reload the MCP server in Claude Desktop or LM Studio." + "SQLite runtime dependency better-sqlite3 is not installed. Open MCP Vault Bridge plugin settings, click Check runtime, then click Install SQLite runtime. After installation, restart or reload the MCP server in Claude Desktop or LM Studio." ); } throw error; diff --git a/packages/plugin/esbuild.config.mjs b/packages/plugin/esbuild.config.mjs index 1317a94..d7c23cd 100644 --- a/packages/plugin/esbuild.config.mjs +++ b/packages/plugin/esbuild.config.mjs @@ -18,9 +18,8 @@ const context = await esbuild.context({ if (watch) { await context.watch(); - console.log("Watching Obsidian MCP plugin..."); + console.log("Watching MCP Vault Bridge plugin..."); } else { await context.rebuild(); await context.dispose(); } - diff --git a/packages/plugin/manifest.json b/packages/plugin/manifest.json index 1294fb5..34af787 100644 --- a/packages/plugin/manifest.json +++ b/packages/plugin/manifest.json @@ -1,6 +1,6 @@ { "id": "mcp-vault-bridge", - "name": "Obsidian MCP", + "name": "MCP Vault Bridge", "version": "0.3.0", "minAppVersion": "1.8.0", "description": "Read-only, exclusion-based local bridge for using an Obsidian vault through MCP clients.", diff --git a/packages/plugin/src/main.ts b/packages/plugin/src/main.ts index 383e309..c1c5cbd 100644 --- a/packages/plugin/src/main.ts +++ b/packages/plugin/src/main.ts @@ -41,7 +41,7 @@ export default class ObsidianMcpPlugin extends Plugin { }); if (!Platform.isDesktopApp) { - new Notice("Obsidian MCP is desktop-only."); + new Notice("MCP Vault Bridge is desktop-only."); return; } @@ -49,7 +49,7 @@ export default class ObsidianMcpPlugin extends Plugin { await this.ensureToken(); } catch (error) { console.error("Unable to initialize MCP bridge token", error); - new Notice("Obsidian MCP could not access Obsidian SecretStorage."); + new Notice("MCP Vault Bridge could not access Obsidian SecretStorage."); return; } @@ -101,7 +101,7 @@ export default class ObsidianMcpPlugin extends Plugin { } catch (error) { this.secretStorageFailed = true; this.lastTokenError = formatTokenError(error); - console.error("Unable to access Obsidian MCP token in SecretStorage; using plugin data fallback", error); + console.error("Unable to access MCP Vault Bridge token in SecretStorage; using plugin data fallback", error); return this.ensureFallbackToken(); } } @@ -119,7 +119,7 @@ export default class ObsidianMcpPlugin extends Plugin { } catch (error) { this.secretStorageFailed = true; this.lastTokenError = formatTokenError(error); - console.error("Unable to regenerate Obsidian MCP token in SecretStorage; using plugin data fallback", error); + console.error("Unable to regenerate MCP Vault Bridge token in SecretStorage; using plugin data fallback", error); } } @@ -141,12 +141,12 @@ export default class ObsidianMcpPlugin extends Plugin { const token = await this.ensureToken(); this.bridge = await createBridgeServer(this, token); this.lastBridgeError = null; - new Notice(`Obsidian MCP listening on 127.0.0.1:${this.settings.port}.`); + new Notice(`MCP Vault Bridge listening on 127.0.0.1:${this.settings.port}.`); } catch (error) { this.bridge = null; this.lastBridgeError = formatBridgeError(error); console.error("Unable to start MCP bridge", error); - new Notice(`Obsidian MCP bridge could not start: ${this.lastBridgeError}`); + new Notice(`MCP Vault Bridge could not start: ${this.lastBridgeError}`); } } diff --git a/packages/plugin/src/settings.ts b/packages/plugin/src/settings.ts index 44fabb2..22c2dae 100644 --- a/packages/plugin/src/settings.ts +++ b/packages/plugin/src/settings.ts @@ -883,7 +883,7 @@ export function buildVaultScopePreview(plugin: ObsidianMcpPlugin): VaultScopePre function renderHeader(containerEl: HTMLElement): void { const header = containerEl.createDiv({ cls: "obsidian-mcp-header" }); - header.createEl("h2", { text: "Obsidian MCP" }); + header.createEl("h2", { text: "MCP Vault Bridge" }); header.createEl("p", { text: "Expose your vault to local MCP clients through a read-only bridge. Returned note snippets can be sent to the model provider used by that client, so keep private areas excluded.", cls: "obsidian-mcp-muted" @@ -1341,7 +1341,7 @@ async function writeRuntimePackageJson(pluginDirectory: string): Promise { name: "mcp-vault-bridge-runtime", version: "0.1.0", private: true, - description: "Runtime dependencies for the Obsidian MCP server bundled inside the Obsidian plugin.", + description: "Runtime dependencies for the MCP Vault Bridge server bundled inside the Obsidian plugin.", dependencies: RUNTIME_DEPENDENCIES }, null, diff --git a/scripts/bundle-plugin.mjs b/scripts/bundle-plugin.mjs index a230a9e..3eea696 100644 --- a/scripts/bundle-plugin.mjs +++ b/scripts/bundle-plugin.mjs @@ -30,7 +30,7 @@ await writeRuntimePackageJson(outputDir); await writeFile( join(outputDir, "README.md"), - `# Obsidian MCP + `# MCP Vault Bridge This whole folder is the standalone local Obsidian plugin. Copy the complete \`mcp-vault-bridge\` folder into: @@ -82,7 +82,7 @@ async function writeRuntimePackageJson(directory) { name: "mcp-vault-bridge-runtime", version: "0.1.0", private: true, - description: "Runtime dependencies for the Obsidian MCP server bundled inside the Obsidian plugin.", + description: "Runtime dependencies for the MCP Vault Bridge server bundled inside the Obsidian plugin.", dependencies: runtimeDependencies }, null, diff --git a/scripts/install-plugin.mjs b/scripts/install-plugin.mjs index 7d2fb03..2fe2ecc 100644 --- a/scripts/install-plugin.mjs +++ b/scripts/install-plugin.mjs @@ -13,9 +13,9 @@ await mkdir(join(vaultPath, ".obsidian", "plugins"), { recursive: true }); await rm(targetDir, { recursive: true, force: true }); await cp(sourceDir, targetDir, { recursive: true, force: true }); -console.log(`Installed Obsidian MCP to: ${targetDir}`); +console.log(`Installed MCP Vault Bridge to: ${targetDir}`); console.log(`Use this MCP server path in Claude Desktop or LM Studio: ${join(targetDir, "mcp-server.cjs")}`); -console.log("Restart Obsidian or reload community plugins, then enable Obsidian MCP."); +console.log("Restart Obsidian or reload community plugins, then enable MCP Vault Bridge."); function resolveVaultPath() { const args = process.argv.slice(2);