notepad-server logo

notepad-server

by GuoAccount

notepad-server is a Model Context Protocol (MCP) server that implements a simple notes system. It demonstrates core MCP concepts by providing tools for creating, managing, and summarizing notes.

View on GitHub

Last updated: N/A

πŸ“ notepad-server MCP Server

δΈ­ζ–‡η‰ˆ

πŸ€– A Model Context Protocol server

πŸ› οΈ This project implements a simple notes system and demonstrates core MCP concepts by providing:

  • Tools for creating new notes
  • Prompts for generating summaries of notes

🌟 Features

πŸ› οΈ Tools

addNotepad

  • Description: Add a new notepad
  • Parameters:
    • name (string): Name of the notepad
    • content (string): Content of the notepad

delNotepad

  • Description: Delete a notepad
  • Parameters:
    • id (number): ID of the notepad to delete

updateNotepad

  • Description: Update a notepad
  • Parameters:
    • id (number): ID of the notepad to update
    • content (string): New content for the notepad

listNotepads

  • Description: List all notepads
  • Parameters: None

useNotepad

  • Description: Use a specific notepad
  • Parameters:
    • id (number): ID of the notepad to use

πŸ› οΈ Development

Install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

πŸ“₯ Installation

To use with Claude Desktop, add the server config:

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "notepad-server": {
      "command": "/path/to/notepad-server/build/index.js"
    }
  }
}

πŸ” Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector, which is available as a package script:

npm run inspector

The Inspector will provide a URL to access debugging tools in your browser.