obsidian-plugin/allexcd_obsidian-mcp
1
0
Fork 0
mirror of https://github.com/allexcd/obsidian-mcp.git synced 2026-07-22 06:50:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: rename plugin display name

Browse source
This commit is contained in:
alexcd 2026-04-30 20:19:24 +02:00
parent 9580fcf652
commit f5d3ce2c16
11 changed files with 20 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -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"

4
README.md
View file

@ -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.

2
manifest.json
View file

@ -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.",

2
packages/mcp-server/src/config.ts
View file

@ -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."
);
}

2
packages/mcp-server/src/database.ts
View file

@ -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;

3
packages/plugin/esbuild.config.mjs
View file

@ -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();
}

2
packages/plugin/manifest.json
View file

@ -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.",

12
packages/plugin/src/main.ts
View file

@ -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}`);
}
}

4
packages/plugin/src/settings.ts
View file

@ -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<void> {
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,

4
scripts/bundle-plugin.mjs
View file

@ -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,

4
scripts/install-plugin.mjs
View file

@ -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);