ne-mcp

# NoteExpress MCP ## Project Overview NoteExpress MCP aims to connect NoteExpress local databases with various AI assistants through the Model Context Protocol (MCP), supporting natural language-driven professional academic queries. ## Features **Currently only supports read-only, write data functionality will be added in future versions** - **Literature Search**: Search for entries (titles, authors, full text, etc.) by keyword, supporting pagination - **PDF Full Text**: Extract readable text from PDF attachments associated with entries - **Folders / Categories**: Browse NE category tree and list entries by folder - **Notes and Entry Details**: Read note content, entry metadata, and attachment information (read-only, no new or modified literature in NE) ## System Requirements - **NoteExpress (Reference Management Software)** must be installed, preferably with at least one literature database opened on this machine Official Website: <https://www.inoteexpress.com/> - **Operating System**: **Windows 64-bit (x64)** (consistent with this MCP release package) - **Optional**: Install **Node.js** (for `npm` / `npx` method to start MCP) ## Quick Start Guide ### Automatic Installation for CLI Tools If you are using Claude Code, Codex, or similar CLI tools that support reading installation instructions, you can directly copy the following text and let the tool read and configure MCP: ```text Help me install NoteExpress MCP, installation instructions at: https://raw.githubusercontent.com/aegean-org/ne-mcp/main/INSTALL.md ``` ### Manual Installation Download the latest zip package from GitHub Releases page ```text https://github.com/aegean-org/ne-mcp/releases/latest ``` Then, write the extracted path to the mcp configuration file - /absolute/path/to/ne-mcp is the extracted file path ```json { "mcpServers": { "ne-mcp": { "command": "/absolute/path/to/ne-mcp", } } } ``` #### Usage Examples - "Help me find literature in NoteExpress containing the keyword 'deep learning'" - "List recent entries under the 'References' folder" - "What methods are mentioned in the PDF full text associated with this literature?" ##### Features Literature search, category browsing, PDF full text extraction, etc. #### Available Tools (Selected) The service provides multiple **`ne.*`** read-only tools, categorized by common capabilities (see the complete list in the repository `README.md`). **Library Discovery** | Tool | Description | |------|-------------| | `ne.get_default_library` | Current default / recently used literature database path | | `ne.list_known_libraries` | Summary of library paths possibly used by NE on this machine | **Entries and Search** | Tool | Description | |------|-------------| | `ne.search_items` | Keyword search for entries and full text | | `ne.list_items` | Paginated browsing and filtering | | `ne.get_item` | Read entry details (including attachments) by ID | **Notes and PDF** | Tool | Description | |------|-------------| | `ne.get_note` | Read notes | | `ne.get_item_pdf_content` | Extract associated PDF full text | **Categories and Configuration** | Tool | Description | |------|-------------| | `ne.get_category_tree` | Category tree | | `ne.get_category_items` | List of entries under a folder | | `ne.get_db_settings` | Database configuration items | | `ne.list_resources` | Attachment / link resource list | ### Supported AI Clients Using Stdio transmission, can be used with MCP-supported clients, such as: - **Claude Desktop / Claude Code** - **Cursor IDE** - **Cherry Studio** and other applications supporting Stdio MCP ### Get Help For questions or suggestions, please submit an issue on the GitHub repository: <https://github.com/aegean-org/ne-mcp/issues> See the repository root directory **`README.md`** for more complete command-line parameters and development compilation instructions.