refactor: remove 'obsidian' from plugin ID and update branding

- Change plugin ID from 'obsidian-mcp-server' to 'mcp-server'
- Remove 'Obsidian' from plugin description per guidelines
- Update documentation to use new plugin folder name
- Update installation paths to .obsidian/plugins/mcp-server/
- Update package name to match new plugin ID
- Simplify README title and description
This commit is contained in:
2025-10-26 16:47:36 -04:00
parent 175aebb218
commit cc4e71f920
7 changed files with 14 additions and 14 deletions

View File

@@ -125,7 +125,7 @@ jobs:
{
"tag_name": "$TAG_VERSION",
"name": "$TAG_VERSION",
"body": "Release $TAG_VERSION\n\n## Changes\n\n*Add release notes here before publishing*\n\n## Installation\n\n1. Download main.js, manifest.json, and styles.css\n2. Create a folder in .obsidian/plugins/obsidian-mcp-server/\n3. Copy the three files into the folder\n4. Reload Obsidian\n5. Enable the plugin in Settings → Community Plugins",
"body": "Release $TAG_VERSION\n\n## Changes\n\n*Add release notes here before publishing*\n\n## Installation\n\n1. Download main.js, manifest.json, and styles.css\n2. Create a folder in .obsidian/plugins/mcp-server/\n3. Copy the three files into the folder\n4. Reload Obsidian\n5. Enable the plugin in Settings → Community Plugins",
"draft": true,
"prerelease": false
}

View File

@@ -27,7 +27,7 @@ The build command includes TypeScript type checking via `tsc -noEmit -skipLibChe
### Installing in Obsidian
After building, the plugin outputs `main.js` to the root directory. To test in Obsidian:
1. Copy `main.js`, `manifest.json`, and `styles.css` to your vault's `.obsidian/plugins/obsidian-mcp-server/` directory
1. Copy `main.js`, `manifest.json`, and `styles.css` to your vault's `.obsidian/plugins/mcp-server/` directory
2. Reload Obsidian (Ctrl/Cmd + R in dev mode)
3. Enable the plugin in Settings → Community Plugins

View File

@@ -1,6 +1,6 @@
# Contributing to Obsidian MCP Server Plugin
# Contributing to MCP Server Plugin
Thank you for your interest in contributing to the Obsidian MCP Server Plugin! This document provides guidelines and information for contributors.
Thank you for your interest in contributing to the MCP Server Plugin! This document provides guidelines and information for contributors.
## Table of Contents
@@ -64,12 +64,12 @@ For feature requests, please describe:
**Linux/macOS:**
```bash
ln -s /path/to/your/dev/obsidian-mcp-server /path/to/vault/.obsidian/plugins/obsidian-mcp-server
ln -s /path/to/your/dev/obsidian-mcp-server /path/to/vault/.obsidian/plugins/mcp-server
```
**Windows (Command Prompt as Administrator):**
```cmd
mklink /D "C:\path\to\vault\.obsidian\plugins\obsidian-mcp-server" "C:\path\to\your\dev\obsidian-mcp-server"
mklink /D "C:\path\to\vault\.obsidian\plugins\mcp-server" "C:\path\to\your\dev\obsidian-mcp-server"
```
4. **Start development build:**

View File

@@ -1,6 +1,6 @@
# Obsidian MCP Server Plugin
# MCP Server Plugin
An Obsidian plugin that makes your vault accessible via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io) over HTTP. This allows AI assistants and other MCP clients to interact with your Obsidian vault programmatically.
A plugin that makes your vault accessible via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io) over HTTP. This allows AI assistants and other MCP clients to interact with your vault programmatically.
**Version:** 1.0.0 | **Tested with:** Obsidian v1.9.14 | **License:** MIT

View File

@@ -1,9 +1,9 @@
{
"id": "obsidian-mcp-server",
"id": "mcp-server",
"name": "MCP Server",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Exposes Obsidian vault operations via Model Context Protocol (MCP) over HTTP.",
"description": "Exposes vault operations via Model Context Protocol (MCP) over HTTP.",
"author": "William Ballou",
"isDesktopOnly": true,
"fundingUrl": {

4
package-lock.json generated
View File

@@ -1,11 +1,11 @@
{
"name": "obsidian-mcp-server",
"name": "mcp-server",
"version": "1.0.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "obsidian-mcp-server",
"name": "mcp-server",
"version": "1.0.0",
"license": "MIT",
"dependencies": {

View File

@@ -1,7 +1,7 @@
{
"name": "obsidian-mcp-server",
"name": "mcp-server",
"version": "1.0.0",
"description": "MCP (Model Context Protocol) server plugin for Obsidian - exposes vault operations via HTTP",
"description": "MCP (Model Context Protocol) server plugin - exposes vault operations via HTTP",
"main": "main.js",
"scripts": {
"dev": "node esbuild.config.mjs",