MCP Server
The Sidvy MCP Server lets AI assistants like Claude and ChatGPT read and write your notes directly. Use natural language to manage your entire note-taking workflow.
What is MCP?
Section titled “What is MCP?”Model Context Protocol (MCP) is an open standard that lets AI assistants connect to external tools and data sources. With the Sidvy MCP server, you can ask your AI assistant to:
- Create and edit notes
- Search across your entire workspace
- Manage todos and track completion
- Organize notes into groups
- Switch between workspaces
Quick Start
Section titled “Quick Start”1. Get Your API Key
Section titled “1. Get Your API Key”- Go to sidvy.com
- Sign in to your account
- Go to Settings > API Keys
- Click Generate New Key
- Copy the key (it’s only shown once)
2. Install the Server
Section titled “2. Install the Server”git clone https://github.com/martinhjartmyr/sidvy-mcp.gitcd sidvy-mcppnpm installpnpm run build3. Configure Your AI Tool
Section titled “3. Configure Your AI Tool”See configuration for:
Claude Desktop
Section titled “Claude Desktop”Add to your claude_desktop_config.json:
{ "mcpServers": { "sidvy": { "command": "node", "args": ["/path/to/sidvy-mcp/build/index.js"], "env": { "SIDVY_API_TOKEN": "sidvy_your_api_key_here", "SIDVY_API_URL": "https://sidvy.com/api" } } }}Replace /path/to/sidvy-mcp with the actual path where you cloned the repository.
Config File Location
Section titled “Config File Location”| OS | Path |
|---|---|
| macOS | ~/Library/Application Support/Claude/claude_desktop_config.json |
| Windows | %APPDATA%\Claude\claude_desktop_config.json |
| Linux | ~/.config/Claude/claude_desktop_config.json |
Claude Code
Section titled “Claude Code”Add to your Claude Code settings (.claude/settings.json or global settings):
{ "mcpServers": { "sidvy": { "command": "node", "args": ["/path/to/sidvy-mcp/build/index.js"], "env": { "SIDVY_API_TOKEN": "sidvy_your_api_key_here", "SIDVY_API_URL": "https://sidvy.com/api" } } }}OpenAI ChatGPT
Section titled “OpenAI ChatGPT”Add to your MCP configuration:
{ "name": "sidvy", "command": ["node", "/path/to/sidvy-mcp/build/index.js"], "env": { "SIDVY_API_TOKEN": "sidvy_your_api_key_here", "SIDVY_API_URL": "https://sidvy.com/api" }}Example Prompts
Section titled “Example Prompts”Once configured, try these prompts:
“Create a new note called ‘Meeting Notes’ with today’s agenda”
“Search for all notes about ‘project planning’”
“Add a section about budget to my Project Alpha note”
“Show me all my pending todos”
“Mark the ‘Review PR’ todo as complete”
“What’s my todo completion rate this week?”
Organization
Section titled “Organization”“Create a group structure for Projects/Web Development/Frontend”
“Move all my meeting notes to the Meetings group”
“Show me the group hierarchy in my workspace”
Workspaces
Section titled “Workspaces”“List all my workspaces”
“Switch to my Work workspace”
“What are the stats for my Personal workspace?”
Available Tools
Section titled “Available Tools”The MCP server provides 30+ tools organized by category.
Notes (8 tools)
Section titled “Notes (8 tools)”| Tool | Description |
|---|---|
list_notes | List notes with filtering and search |
create_note | Create new markdown notes |
update_note | Edit note content and metadata |
delete_note | Move notes to trash |
search_notes | Full-text search across notes |
get_note | Retrieve specific note by ID |
get_recent_notes | Get recently updated notes |
append_to_note | Add content to existing notes |
Groups (9 tools)
Section titled “Groups (9 tools)”| Tool | Description |
|---|---|
list_groups | List groups with hierarchical structure |
create_group | Create new groups |
update_group | Rename or move groups |
delete_group | Remove groups (cascade optional) |
get_group_tree | Get complete group hierarchy |
get_root_groups | Get top-level groups |
get_child_groups | Get children of a group |
move_group | Reorganize group structure |
create_group_path | Create nested paths like A/B/C |
Todos (11 tools)
Section titled “Todos (11 tools)”| Tool | Description |
|---|---|
list_todos | List todos with filtering |
create_todo | Create new todos |
update_todo | Edit todo text or status |
delete_todo | Remove todos |
toggle_todo | Switch completion status |
complete_todo | Mark as complete |
uncomplete_todo | Mark as incomplete |
get_pending_todos | Get incomplete todos |
get_completed_todos | Get finished todos |
get_todos_for_note | Get todos in a specific note |
get_todo_stats | Get completion statistics |
Workspaces (10 tools)
Section titled “Workspaces (10 tools)”| Tool | Description |
|---|---|
list_workspaces | List all workspaces |
create_workspace | Create new workspace |
update_workspace | Rename workspaces |
delete_workspace | Remove workspace and content |
get_workspace | Get workspace details |
get_default_workspace | Get user’s default workspace |
get_workspace_by_name | Find workspace by name |
get_workspace_stats | Get content statistics |
can_create_workspace | Check if limit reached |
switch_workspace | Change active workspace |
Environment Variables
Section titled “Environment Variables”| Variable | Required | Description |
|---|---|---|
SIDVY_API_TOKEN | Yes | Your API key from Settings |
SIDVY_API_URL | No | API URL (default: https://sidvy.com/api) |
DEBUG | No | Enable debug logging |
Troubleshooting
Section titled “Troubleshooting”Server Not Starting
Section titled “Server Not Starting”- Verify Node.js 18+ is installed:
node --version - Ensure you ran
pnpm run build - Check the path in your config is correct
Authentication Errors
Section titled “Authentication Errors”- Verify your API key is valid in Sidvy Settings
- Check the key hasn’t been revoked
- Ensure no extra spaces in the config
Tools Not Appearing
Section titled “Tools Not Appearing”- Restart your AI application after config changes
- Check the config file syntax (valid JSON)
- Look for errors in the AI application logs
Rate Limiting
Section titled “Rate Limiting”The server handles rate limits automatically with retries. If you see rate limit errors, reduce request frequency.
Source Code
Section titled “Source Code”The MCP server is open source:
github.com/martinhjartmyr/sidvy-mcp
Contributions welcome!