-
Notifications
You must be signed in to change notification settings - Fork 1.9k
feat: update README with MCP server references #346
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
+200
−0
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| # Model Context Protocol (MCP) Integration | ||
|
|
||
| Open Notebook can be seamlessly integrated into your AI workflows using the **Model Context Protocol (MCP)**, enabling direct access to your notebooks, sources, and chat functionality from AI assistants like Claude Desktop and VS Code extensions. | ||
|
|
||
| ## What is MCP? | ||
|
|
||
| The [Model Context Protocol](https://modelcontextprotocol.io) is an open standard that allows AI applications to securely connect to external data sources and tools. With the Open Notebook MCP server, you can: | ||
|
|
||
| - 📚 **Access your notebooks** directly from Claude Desktop or VS Code | ||
| - 🔍 **Search your research content** without leaving your AI assistant | ||
| - 💬 **Create and manage chat sessions** with your research as context | ||
| - 📝 **Generate notes** and insights on-the-fly | ||
| - 🤖 **Automate workflows** using the full Open Notebook API | ||
|
|
||
| ## Quick Setup | ||
|
|
||
| ### For Claude Desktop | ||
|
|
||
| 1. **Install the MCP server** (automatically from PyPI): | ||
|
|
||
| ```bash | ||
| # No manual installation needed! Claude Desktop will use uvx to run it automatically | ||
| ``` | ||
|
|
||
| 2. **Configure Claude Desktop**: | ||
|
|
||
| **macOS/Linux**: Edit `~/Library/Application Support/Claude/claude_desktop_config.json` | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "open-notebook": { | ||
| "command": "uvx", | ||
| "args": ["open-notebook-mcp"], | ||
| "env": { | ||
| "OPEN_NOTEBOOK_URL": "http://localhost:5055", | ||
| "OPEN_NOTEBOOK_PASSWORD": "your_password_here" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| **Windows**: Edit `%APPDATA%\Claude\claude_desktop_config.json` | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "open-notebook": { | ||
| "command": "uvx", | ||
| "args": ["open-notebook-mcp"], | ||
| "env": { | ||
| "OPEN_NOTEBOOK_URL": "http://localhost:5055", | ||
| "OPEN_NOTEBOOK_PASSWORD": "your_password_here" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 3. **Restart Claude Desktop** and start using your notebooks in conversations! | ||
|
|
||
| ### For VS Code (Cline and other MCP-compatible extensions) | ||
|
|
||
| Add to your VS Code settings or `.vscode/mcp.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "servers": { | ||
| "open-notebook": { | ||
| "command": "uvx", | ||
| "args": ["open-notebook-mcp"], | ||
| "env": { | ||
| "OPEN_NOTEBOOK_URL": "http://localhost:5055", | ||
| "OPEN_NOTEBOOK_PASSWORD": "your_password_here" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| - **OPEN_NOTEBOOK_URL**: URL to your Open Notebook API (default: `http://localhost:5055`) | ||
| - **OPEN_NOTEBOOK_PASSWORD**: Optional - only needed if you've enabled password protection | ||
|
|
||
| ### For Remote Servers | ||
|
|
||
| If your Open Notebook instance is running on a remote server, update the URL accordingly: | ||
|
|
||
| ```json | ||
| "OPEN_NOTEBOOK_URL": "http://192.168.1.100:5055" | ||
| ``` | ||
|
|
||
| Or with a domain: | ||
|
|
||
| ```json | ||
| "OPEN_NOTEBOOK_URL": "https://notebook.yourdomain.com/api" | ||
| ``` | ||
|
|
||
| ## What You Can Do | ||
|
|
||
| Once connected, you can ask Claude or your AI assistant to: | ||
|
|
||
| - _"Search my research notebooks for information about [topic]"_ | ||
| - _"Create a new note summarizing the key points from our conversation"_ | ||
| - _"List all my notebooks"_ | ||
| - _"Start a chat session about [specific source or topic]"_ | ||
| - _"What sources do I have in my [notebook name] notebook?"_ | ||
| - _"Add this PDF to my research notebook"_ | ||
| - _"Show me all notes in [notebook name]"_ | ||
|
|
||
| The MCP server provides full access to Open Notebook's capabilities, allowing you to manage your research seamlessly from within your AI assistant. | ||
|
|
||
| ## Available Tools | ||
|
|
||
| The Open Notebook MCP server exposes these capabilities: | ||
|
|
||
| ### Notebooks | ||
|
|
||
| - List notebooks | ||
| - Get notebook details | ||
| - Create new notebooks | ||
| - Update notebook information | ||
| - Delete notebooks | ||
|
|
||
| ### Sources | ||
|
|
||
| - List sources in a notebook | ||
| - Get source details | ||
| - Add new sources (links, files, text) | ||
| - Update source metadata | ||
| - Delete sources | ||
|
|
||
| ### Notes | ||
|
|
||
| - List notes in a notebook | ||
| - Get note details | ||
| - Create new notes | ||
| - Update notes | ||
| - Delete notes | ||
|
|
||
| ### Chat | ||
|
|
||
| - Create chat sessions | ||
| - Send messages to chat sessions | ||
| - Get chat history | ||
| - List chat sessions | ||
|
|
||
| ### Search | ||
|
|
||
| - Vector search across content | ||
| - Text search across content | ||
| - Filter by notebook | ||
|
|
||
| ### Models | ||
|
|
||
| - List configured AI models | ||
| - Get model details | ||
| - Create model configurations | ||
| - Update model settings | ||
|
|
||
| ### Settings | ||
|
|
||
| - Get application settings | ||
| - Update settings | ||
|
|
||
| ## MCP Server Repository | ||
|
|
||
| The Open Notebook MCP server is developed and maintained by the Epochal team: | ||
|
|
||
| **🔗 GitHub**: [Epochal-dev/open-notebook-mcp](https://github.com/Epochal-dev/open-notebook-mcp) | ||
|
|
||
| Contributions, issues, and feature requests are welcome! | ||
|
|
||
| ## Finding the Server | ||
|
|
||
| The Open Notebook MCP server is published to the official MCP Registry: | ||
|
|
||
| - **Registry**: Search for "open-notebook" at [registry.modelcontextprotocol.io](https://registry.modelcontextprotocol.io) | ||
| - **PyPI**: [pypi.org/project/open-notebook-mcp](https://pypi.org/project/open-notebook-mcp) | ||
| - **GitHub**: [Epochal-dev/open-notebook-mcp](https://github.com/Epochal-dev/open-notebook-mcp) | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Connection Errors | ||
|
|
||
| 1. Verify the `OPEN_NOTEBOOK_URL` is correct and accessible | ||
| 2. If using password protection, ensure `OPEN_NOTEBOOK_PASSWORD` is set correctly | ||
| 3. For remote servers, make sure port 5055 is accessible from your machine | ||
| 4. Check firewall settings if connecting to a remote server | ||
|
|
||
| ## Using with Other MCP Clients | ||
|
|
||
| The Open Notebook MCP server follows the standard MCP protocol and can be used with any MCP-compatible client. Check your client's documentation for configuration details. | ||
|
|
||
| ## Learn More | ||
|
|
||
| - [Model Context Protocol Documentation](https://modelcontextprotocol.io) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.