Skip to content

Notes server based on TypeScript implementation of the MCP protocol, providing functions for adding, removing, and updating notes, and supporting integration with Claude Desktop.基于 TypeScript 实现的 MCP 协议笔记服务器,提供笔记的添加、删除、更新等功能,支持与 Claude Desktop 集成。

Notifications You must be signed in to change notification settings

GuoAccount/notepad-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📝 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.

About

Notes server based on TypeScript implementation of the MCP protocol, providing functions for adding, removing, and updating notes, and supporting integration with Claude Desktop.基于 TypeScript 实现的 MCP 协议笔记服务器,提供笔记的添加、删除、更新等功能,支持与 Claude Desktop 集成。

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published