obsidian-plugin/aaronsb_obsidian-mcp-plugin
1
0
Fork 0
mirror of https://github.com/aaronsb/obsidian-mcp-plugin.git synced 2026-07-22 06:45:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: Add scripts/make-mcpb.mjs interactive maker for advanced users

Browse source 
Power users with multiple Obsidian vaults (or anyone wanting a
custom-named bundle) run `node scripts/make-mcpb.mjs`, answer three
prompts (display name, URL, API key), and get an
obsidian-mcp-<slug>.mcpb with the chosen name and defaults
pre-filled. Drop it into Claude Desktop — one-click install with no
manual entry in the user_config dialog.

Shares the zip builder with scripts/build-mcpb.mjs so there's a
single source of truth for the bundle format. Zero deps; Node ≥18.

This is the path ADR-102 §6 designates for multi-vault setups,
replacing both the rejected N-slot manifest design and the
multi-variant publishing alternative.

Refs ADR-102.
This commit is contained in:
Aaron Bockelie 2026-05-15 11:31:57 -05:00
parent 7ca31c4685
commit 7f77b72b6c
1 changed files with 49 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
scripts/make-mcpb.mjs Normal file
View file

@ -0,0 +1,49 @@
#!/usr/bin/env node
// Interactive .mcpb maker for advanced users.
// Prompts for name, url, api_key, then emits obsidian-mcp-<name>.mcpb
// using the same pure-Node zip helper as the canonical build.
import { readFileSync, writeFileSync } from 'node:fs';
import { createInterface } from 'node:readline/promises';
import { stdin, stdout } from 'node:process';
import { buildMcpb } from './build-mcpb.mjs';
const rl = createInterface({ input: stdin, output: stdout });
const slugify = (s) => s.toLowerCase().replace(/[^a-z0-9-]+/g, '-').replace(/^-+|-+$/g, '');
const ask = async (q, fallback) => {
const a = (await rl.question(`${q}${fallback ? ` [${fallback}]` : ''}: `)).trim();
return a || fallback || '';
};
try {
console.log('Obsidian MCPB maker — generates a custom-named bundle for one vault.\n');
const displayName = await ask('Display name shown in Claude Desktop', 'Obsidian (Work Vault)');
const slug = slugify(displayName) || 'obsidian-mcp-custom';
const url = await ask('Obsidian MCP URL', 'http://localhost:3001/mcp');
const apiKey = await ask('API key (leave blank only if plugin auth is disabled)', '');
const baseManifest = JSON.parse(readFileSync('mcpb/manifest.json', 'utf-8'));
const serverJs = readFileSync('mcpb/server.js', 'utf-8');
const manifest = {
...baseManifest,
name: slug,
display_name: displayName,
user_config: {
...baseManifest.user_config,
url: { ...baseManifest.user_config.url, default: url },
api_key: { ...baseManifest.user_config.api_key, default: apiKey },
},
};
const out = `obsidian-mcp-${slug}.mcpb`;
writeFileSync(out, buildMcpb({ manifest, serverJs }));
console.log(`\n✅ Built ${out}`);
console.log(` Drop it into Claude Desktop to install "${displayName}".`);
console.log(' The URL and API key are pre-filled — just click Install.');
} finally {
rl.close();
}