Release v1.0.0 - Initial Release
🎉 Initial release of Obsidian MCP Server plugin
Core Features:
- MCP server implementation with HTTP transport
- JSON-RPC 2.0 message handling
- Protocol version 2024-11-05 support
MCP Tools:
- read_note, create_note, update_note, delete_note
- search_notes, list_notes, get_vault_info
Server Features:
- Configurable HTTP server (default port: 3000)
- Health check and MCP endpoints
- Auto-start option
Security:
- Origin header validation (DNS rebinding protection)
- Optional Bearer token authentication
- CORS configuration
UI:
- Settings panel with full configuration
- Status bar indicator and ribbon icon
- Start/Stop/Restart commands
Documentation:
- Comprehensive README with examples
- Quick Start Guide and Implementation Summary
- Test client script
This commit is contained in:
45
.windsurf/rules/troubleshooting.md
Normal file
45
.windsurf/rules/troubleshooting.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
trigger: always_on
|
||||
description: Common issues and solutions
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
## Plugin Doesn't Load After Build
|
||||
|
||||
**Issue**: Plugin doesn't appear in Obsidian after building
|
||||
|
||||
**Solution**: Ensure `main.js` and `manifest.json` are at the top level of the plugin folder under `<Vault>/.obsidian/plugins/<plugin-id>/`
|
||||
|
||||
## Build Issues
|
||||
|
||||
**Issue**: `main.js` is missing after build
|
||||
|
||||
**Solution**: Run `npm run build` or `npm run dev` to compile your TypeScript source code
|
||||
|
||||
## Commands Not Appearing
|
||||
|
||||
**Issue**: Commands don't show up in command palette
|
||||
|
||||
**Solution**:
|
||||
- Verify `addCommand` runs after `onload`
|
||||
- Ensure command IDs are unique
|
||||
- Check that commands are properly registered
|
||||
|
||||
## Settings Not Persisting
|
||||
|
||||
**Issue**: Settings reset after reloading Obsidian
|
||||
|
||||
**Solution**:
|
||||
- Ensure `loadData`/`saveData` are awaited
|
||||
- Re-render the UI after changes
|
||||
- Verify settings are properly merged with defaults
|
||||
|
||||
## Mobile-Only Issues
|
||||
|
||||
**Issue**: Plugin works on desktop but not mobile
|
||||
|
||||
**Solution**:
|
||||
- Confirm you're not using desktop-only APIs
|
||||
- Check `isDesktopOnly` setting in manifest
|
||||
- Test on actual mobile devices or adjust compatibility
|
||||
Reference in New Issue
Block a user