Files
obsidian-mcp-server/.windsurf/rules/ux-guidelines.md
Bill 08cc6e9ea6 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
2025-10-16 20:52:52 -04:00

32 lines
734 B
Markdown

---
trigger: always_on
description: UX and copy guidelines for UI text
---
# UX & Copy Guidelines
For UI text, commands, and settings:
## Text Formatting
- **Prefer sentence case** for headings, buttons, and titles
- Use clear, action-oriented imperatives in step-by-step copy
- Keep in-app strings short, consistent, and free of jargon
## UI References
- Use **bold** to indicate literal UI labels
- Prefer "select" for interactions
- Use arrow notation for navigation: **Settings → Community plugins**
## Examples
✅ Good:
- "Select **Settings → Community plugins**"
- "Enable the plugin"
- "Configure your API key"
❌ Avoid:
- "Go to Settings and then Community plugins"
- "Turn on the plugin"
- "Setup your API key"