mirror of
https://github.com/aaronsb/obsidian-mcp-plugin.git
synced 2026-07-22 06:45:14 +00:00
docs(readme): lead with install + emoji .mcpb→Claude Desktop banner
Move Quick Start above the conceptual sections so install is the first thing readers hit, and relocate 'Why Semantic MCP?' down to before Core Tools. Add an inline-emoji hero banner (box → robot) for the .mcpb drag-into-Claude-Desktop flow — glyphs render on the Obsidian listing where embedded images get stripped, making the one-click path obvious to non-power-users.
This commit is contained in:
parent
7b6dd03367
commit
a09e667b33
1 changed files with 17 additions and 12 deletions
29
README.md
29
README.md
|
|
@ -17,18 +17,14 @@ This plugin connects your Obsidian vault to AI assistants through MCP (Model Con
|
|||
- Claude Code/Continue.dev (VS Code)
|
||||
- Any platform that supports local MCP servers
|
||||
|
||||
## Why Semantic MCP?
|
||||
|
||||
Traditional file access gives AI a narrow view - one document at a time. This plugin transforms that into **semantic agency**:
|
||||
|
||||
- **Graph Navigation**: AI follows links between notes, understanding relationships and context
|
||||
- **Concept Discovery**: Semantic search finds related ideas across your vault
|
||||
- **Contextual Awareness**: AI understands where information lives in your knowledge structure
|
||||
- **Intelligent Synthesis**: Combine fragments from multiple notes to answer complex questions
|
||||
|
||||
## Quick Start
|
||||
|
||||
**Prerequisites:** You need an MCP-compatible AI client like Claude Desktop, Claude Code, or Continue.dev.
|
||||
**Prerequisites:** an MCP-compatible AI client like Claude Desktop, Claude Code, or Continue.dev.
|
||||
|
||||
> ## 📦 ──drag──▶ 🤖💬
|
||||
> **Download the `.mcpb` bundle from the plugin's config page → drag it onto Claude Desktop → paste your key. Done.**
|
||||
|
||||
For most people that's the entire setup. The numbered steps below spell it out, then cover other MCP clients.
|
||||
|
||||
### 1. Install the Plugin
|
||||
|
||||
|
|
@ -45,9 +41,9 @@ Traditional file access gives AI a narrow view - one document at a time. This pl
|
|||
|
||||
Three onboarding paths, ordered by audience. All three are also shown in the plugin's Settings tab with copy-ready values.
|
||||
|
||||
**Claude Desktop — one-click `.mcpb` install (recommended)**
|
||||
**📦 → 🤖 Claude Desktop — one-click `.mcpb` install (recommended)**
|
||||
|
||||
Download `obsidian-mcp-<version>.mcpb` from the [latest release](https://github.com/aaronsb/obsidian-mcp-plugin/releases/latest), then either drag it onto the Claude Desktop window or double-click it. Claude Desktop opens an install dialog with two fields — paste the URL and API key shown in the plugin's Settings tab, hit Save, and you're done.
|
||||
Download `obsidian-mcp-<version>.mcpb` — either from the plugin's **Settings** tab (button right on the config page) or the [latest release](https://github.com/aaronsb/obsidian-mcp-plugin/releases/latest) — then either drag it onto the Claude Desktop window or double-click it. Claude Desktop opens an install dialog with two fields — paste the URL and API key shown in the plugin's Settings tab, hit Save, and you're done.
|
||||
|
||||
> *Cross-platform note:* `.mcpb` files install via Claude Desktop's bundled handler. If double-click doesn't trigger Claude on your system, drag the file onto Claude Desktop's window instead, or right-click → "Open with…" and pick Claude Desktop (then "always open with" if your OS asks). Behavior varies by platform: macOS usually auto-associates, Windows may need a one-time association, Linux varies by desktop environment.
|
||||
|
||||
|
|
@ -134,6 +130,15 @@ Your AI assistant now has these capabilities:
|
|||
- Work with Dataview queries (if installed)
|
||||
- Manage Obsidian Bases (database views)
|
||||
|
||||
## Why Semantic MCP?
|
||||
|
||||
Traditional file access gives AI a narrow view - one document at a time. This plugin transforms that into **semantic agency**:
|
||||
|
||||
- **Graph Navigation**: AI follows links between notes, understanding relationships and context
|
||||
- **Concept Discovery**: Semantic search finds related ideas across your vault
|
||||
- **Contextual Awareness**: AI understands where information lives in your knowledge structure
|
||||
- **Intelligent Synthesis**: Combine fragments from multiple notes to answer complex questions
|
||||
|
||||
## Core Tools
|
||||
|
||||
The plugin provides 8 semantic tool groups that give AI comprehensive vault access:
|
||||
|
|
|
|||
Loading…
Reference in a new issue