MCP Server Inbox

🚀 MCP-Server-Inbox

The MCP service integrates with the inBox Notes API, enabling the creation of notes in a conversational manner on any MCP client.

🚀 Quick Start

The MCP-Server-Inbox connects to the inBox Notes API, allowing users to create notes in a conversational style on any MCP client.

✨ Features

• Integrate with the inBox Notes API.
• Provide an MCP service discovery interface.
• Support note creation via MCP clients.
• Allow optional note title setting.
• Support the Inspector debugging tool.

📦 Installation

Prerequisites

• Node.js 18+
• inBox Notes API (PRO feature)
• A client supporting the MCP protocol

Installation Steps

Install the project using the following command:

npm install mcp-server-inbox

Configuration

The project supports two configuration methods:

1. Token Configuration: Set INBOX_TOKEN in the environment variables.
2. Full URL Configuration: Set INBOX_API_URL in the environment variables.

💻 Usage Examples

Start the Service

Start the MCP server with the following command:

node index.js

Basic Usage

Users can create notes by entering the following content in the MCP client:

帮我记笔记，标题是「我的第一个笔记」：这是笔记内容...

The service will automatically extract the title and content and call the inBox API to create the note.

📚 Documentation

Debugging Tool

The project includes an Inspector debugging tool, which supports real-time monitoring and debugging of the service's running status. Refer to the documentation for specific usage.

API Specification

Request Format

POST /api/note HTTP/1.1
Content-Type: application/json

{
    "title": "string",
    "content": "string"
}

Response Format

{
    "code": integer,
    "message": string
}

Example Response:

{
    "code": 0,
    "message": "笔记创建成功"
}

Processing Logic

1. Parse user input to identify the title and content.
2. Call the inBox API to create the note.
3. Return the processing result.

Notes

⚠️ Important Note

• A maximum of 50 notes can be created per day.
• Note content should not exceed 3000 characters.
• API functionality requires an inBox PRO user account.

Obtaining API Configuration

1. Open the inBox application.
2. Navigate to 【Settings】 -> 【Account】 -> 【API】.
3. Obtain the exclusive API configuration information.

Contribution Guidelines

Welcome to submit issues and pull requests. Before submitting a PR, ensure that:

• The code compiles with TypeScript.
• All functions have been tested.
• The documentation is updated.

Changelog

v0.1.0

• Initial release.
• Support basic note creation.
• Support both Token and full URL configuration methods.
• Add support for the Inspector debugging tool.

Author Information

gudong - Personal Homepage

Related Projects

• inBox - A simple and useful note-taking service.
• MCP Protocol - Model Context Protocol specification.

📄 License

MIT