MCP Notes

🚀 MCP Notes Server

An implementation of a Model Context Protocol (MCP) server for managing notes with persistent storage.

🚀 Quick Start

Installation

Install via Smithery

To automatically install notes for Claude Desktop, use Smithery:

npx -y @smithery/cli install notes --client claude

Manual Installation

1. Ensure Python 3.10 or higher is installed.
2. Create a virtual environment:

   python -m venv .venv
   
   # On Unix/MacOS:
   source .venv/bin/activate
   
   # On Windows:
   .venv\Scripts\activate
   

3. Install the requirements:

   pip install MCP
   

Starting the Server

1. Start the server:

   mcp install src/notes
   mcp start Notes
   

2. Example operations:

   # Create a note
   await client.call_tool("add-note", {
       "name": "example",
       "content": "This is a test note"
   })
   
   # List all notes
   await client.call_tool("list-all-notes")
   
   # Update a note
   await client.call_tool("update-note", {
       "name": "example",
       "content": "Updated content"
   })
   
   # Delete a note
   await client.call_tool("delete-note", {
       "name": "example"
   })
   

✨ Features

• Create, read, update, and delete notes.
• Use JSON for persistent storage.
• Record creation and modification timestamps.
• Generate note summaries via prompts.
• Resource-based access control using the note:// URI scheme.

📦 Installation

Install via Smithery

To automatically install notes for Claude Desktop, use Smithery:

npx -y @smithery/cli install notes --client claude

Manual Installation

1. Ensure Python 3.10 or higher is installed.
2. Create a virtual environment:

   python -m venv .venv
   
   # On Unix/MacOS:
   source .venv/bin/activate
   
   # On Windows:
   .venv\Scripts\activate
   

3. Install the requirements:

   pip install MCP
   

💻 Usage Examples

Basic Usage

# Create a note
await client.call_tool("add-note", {
    "name": "example",
    "content": "This is a test note"
})

# List all notes
await client.call_tool("list-all-notes")

# Update a note
await client.call_tool("update-note", {
    "name": "example",
    "content": "Updated content"
})

# Delete a note
await client.call_tool("delete-note", {
    "name": "example"
})

📚 Documentation

Project Structure

notes/
├── __init__.py          # Package initialization
├── server.py           # Main server implementation
├── storage.py          # Note persistence layer
├── resources.py        # Resource handling (note:// URI)
├── prompts.py         # LLM prompt generation
└── tools/             # Server tools
    ├── __init__.py    # Tool package initialization
    ├── list_tools.py  # Tool listing functionality
    └── handle_tools.py # Tool handling implementation

Available Tools

• add-note: Create a new note.
• list-all-notes: Display all stored notes.
• update-note: Modify an existing note.
• delete-note: Delete a note.

Storage

Notes are stored in notes_storage.json with the following structure:

{
    "note_name": {
        "content": "Note content",
        "created_at": "2025-01-12T11:28:16.721704",
        "modified_at": "2025-01-12T11:28:16.721704"
    }
}

Resource Access

Notes can be accessed as resources using the note:// URI scheme:

• List resources: Return all available notes.
• Read a resource: Access a specific note using note://internal/note_name.

Prompt Generation

The server includes a prompt generation feature for note summaries:

• Supports short and detailed summaries.
• The note format is suitable for language model input.
• Use the generate-summary tool to generate summaries.

Development

Clone the Repository

Clone this repository using the following command:

git clone https://github.com/your-username/notes-mcp.git
cd notes-mcp

Dependencies

Ensure the following Python packages are installed:

• flask: For the Web interface.
• python-dotenv: For environment variable management.
• requests: For API requests.

Run the Server

After installing the dependencies, run:

python server.py

Access http://localhost:5000 to view the Web interface.

Contribution

Contributions are welcome! Please refer to CONTRIBUTING.md to learn how to participate in the development.