Skip to content

Conversation

@PiotrAleksander
Copy link

Description

New advanced topic in the documentation: MCP. Links to guide on how to use Open Notebook MCP from official registry.

Related Issue

#81 - partly addresses MCP.

Fixes #81

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring (no functional changes)
  • Performance improvement
  • Test coverage improvement

How Has This Been Tested?

  • Tested locally with Docker
  • Tested locally with development setup
  • Added new unit tests
  • Existing tests pass (uv run pytest)
  • Manual testing performed (describe below)

Test Details:
open-notebook-mcp has it's own automated tests suite, I've also tested it manually.

Design Alignment

Which design principles does this PR support? (See DESIGN_PRINCIPLES.md)

  • Privacy First
  • Simplicity Over Features
  • API-First Architecture
  • Multi-Provider Flexibility
  • Extensibility Through Standards
  • Async-First for Performance

Explanation:
It's information for people wanting to leverage Open Notebook from their other agents (I use Codex to manage my notebooks).

Checklist

Code Quality

  • My code follows PEP 8 style guidelines (Python)
  • My code follows TypeScript best practices (Frontend)
  • I have added type hints to my code (Python)
  • I have added JSDoc comments where appropriate (TypeScript)
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings or errors

Testing

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I ran linting: make ruff or ruff check . --fix
  • I ran type checking: make lint or uv run python -m mypy .

Documentation

  • I have updated the relevant documentation in /docs (if applicable)
  • I have added/updated docstrings for new/modified functions
  • I have updated the API documentation (if API changes were made)
  • I have added comments to complex logic

Database Changes

  • I have created migration scripts for any database schema changes (in /migrations)
  • Migration includes both up and down scripts
  • Migration has been tested locally

Breaking Changes

  • This PR includes breaking changes
  • I have documented the migration path for users
  • I have updated MIGRATION.md (if applicable)

Screenshots (if applicable)

Additional Context

It was briefly discussed on discord

Pre-Submission Verification

Before submitting, please verify:

  • I have read CONTRIBUTING.md
  • I have read DESIGN_PRINCIPLES.md
  • This PR addresses an approved issue that was assigned to me
  • I have not included unrelated changes in this PR
  • My PR title follows conventional commits format (e.g., "feat: add user authentication")

Thank you for contributing to Open Notebook! 🎉

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 2 files

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="docs/features/mcp-integration.md">

<violation number="1" location="docs/features/mcp-integration.md:27">
P2: The path `~/Library/Application Support/` is macOS-specific and will not exist on Linux systems. Consider either separating the macOS and Linux instructions or labeling this as macOS-only. Linux users following these instructions will look for a non-existent directory.</violation>
</file>

Since this is your first cubic review, here's how it works:

  • cubic automatically reviews your code and comments on bugs and improvements
  • Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
  • Ask questions if you need clarification on any suggestion

Reply to cubic to teach it or ask questions. Re-run a review with @cubic-dev-ai review this PR


2. **Configure Claude Desktop**:

**macOS/Linux**: Edit `~/Library/Application Support/Claude/claude_desktop_config.json`
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: The path ~/Library/Application Support/ is macOS-specific and will not exist on Linux systems. Consider either separating the macOS and Linux instructions or labeling this as macOS-only. Linux users following these instructions will look for a non-existent directory.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/features/mcp-integration.md, line 27:

<comment>The path `~/Library/Application Support/` is macOS-specific and will not exist on Linux systems. Consider either separating the macOS and Linux instructions or labeling this as macOS-only. Linux users following these instructions will look for a non-existent directory.</comment>

<file context>
@@ -0,0 +1,199 @@
+
+2. **Configure Claude Desktop**:
+
+   **macOS/Linux**: Edit `~/Library/Application Support/Claude/claude_desktop_config.json`
+
+   ```json
</file context>
Fix with Cubic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Headless mode through APIs

1 participant