CN

catoncat/notion-local-ops-mcp

开发工具
102 stars 0 forks 质量 35 趋势 35

Turn a Notion into a local coding agent for local files, shell, git, and delegated tasks.

概览

Turn a Notion into a local coding agent for local files, shell, git, and delegated tasks.

README

notion-local-ops-mcp

中文说明

Turn a Notion MCP Agent into a local coding agent for local files, shell, git, and delegated tasks.

What This Project Does

  • exposes local files, shell, git, and patch-style editing through MCP
  • lets an MCP Agent work on a real local repo instead of only editing Notion pages
  • supports delegated long-running tasks through local codex or claude

Quick Start

git clone https://github.com//notion-local-ops-mcp.git
cd notion-local-ops-mcp
cp .env.example .env
./scripts/dev-tunnel.sh

Set at least:

NOTION_LOCAL_OPS_WORKSPACE_ROOT="/absolute/path/to/workspace"
NOTION_LOCAL_OPS_AUTH_TOKEN="replace-me"

Important MCP Agent Configuration

Use this in your MCP Agent configuration inside Notion:

  • URL: https:///mcp
  • Auth type: Bearer
  • Token: NOTION_LOCAL_OPS_AUTH_TOKEN

ChatGPT Web OAuth

ChatGPT web developer mode expects an HTTPS MCP endpoint and can connect with OAuth. This project implements a minimal OAuth compatibility mode for local use: dynamic client registration, PKCE authorization code flow, protected resource metadata, and bearer access tokens. It does not implement a full user account system or ChatGPT iframe UI widgets.

Enable OAuth mode in .env:

NOTION_LOCAL_OPS_AUTH_MODE=oauth
NOTION_LOCAL_OPS_PUBLIC_BASE_URL="https://"
NOTION_LOCAL_OPS_AUTH_TOKEN="replace-me"
# Optional: use a separate login token for the OAuth authorization page.
# NOTION_LOCAL_OPS_OAUTH_LOGIN_TOKEN="replace-me"

Then restart the service. For launchd-managed installs, reinstall or restart so the generated plist receives the new env values:

./scripts/install-launchd.sh

Create the ChatGPT app/connector with:

  • MCP server URL: https:///mcp
  • Authentication: OAuth
  • Client registration: dynamic registration, if ChatGPT offers the choice

When ChatGPT opens the authorization page, enter NOTION_LOCAL_OPS_AUTH_TOKEN unless NOTION_LOCAL_OPS_OAUTH_LOGIN_TOKEN is set.

Smoke-test the public OAuth surface before adding it to ChatGPT:

curl -sS https:///.well-known/oauth-protected-resource/mcp
curl -sS https:///.well-known/oauth-authorization-server
curl -i https:///mcp

The first two commands should return JSON metadata. The /mcp request without credentials should return 401 with a WWW-Authenticate header containing resource_metadata.

OAuth security notes

  • Always set NOTION_LOCAL_OPS_PUBLIC_BASE_URL in OAuth mode. Without it the issuer URL falls back to the request Host header, which a tunnel attacker can spoof to steer OAuth metadata at a phishing host. The server prints a startup warning when this happens.
  • Prefer a dedicated NOTION_LOCAL_OPS_OAUTH_LOGIN_TOKEN. If it falls back to AUTH_TOKEN, anyone who briefly sees AUTH_TOKEN can mint a long-TTL OAuth access token (default 24h) that survives a token rotation. After rotating AUTH_TOKEN, also clear the tokens map in /oauth.json to invalidate any minted access tokens.
  • oauth.json and the STATE_DIR task tree are written with 0o600/0o700 permissions so other local users cannot read minted tokens or task logs. Existing files created before this change should be chmod’d manually (chmod 600 ~/.notion-local-ops-mcp/oauth.json).

Use the prompt below for the MCP Agent. It is not for the Notion AI instruction page.

Relay Bridge (mirror tool calls to a dashboard)

When paired with workspace-agent-relay-mcp, every tool call an agent makes here can be auto-mirrored to that relay’s live dashboard — so a local operator watches the agent work without it manually reporting anything.

How it works:

  1. The agent calls bind_relay_run here with the request_id + callback_token from a relay trigger (no relay URL needed — it’s configured locally).
  2. Every @traced tool call thereafter fires a fire-and-forget POST /internal/tool-trace to the relay.
  3. The relay stores it and pushes it to the dashboard over SSE.

It’s a generic instrumentation layer (@traced decorator + pluggable sinks), so the relay is just one sink — not hardcoded. The relay being unreachable never blocks tool execution; traces are best-effort.

Env knobs:

NOTION_LOCAL_OPS_RELAY_BRIDGE_ENABLED=true     # default true; set false to disable entirely
NOTION_LOCAL_OPS_RELAY_URL=http://127.0.0.1:8799  # default relay endpoint used by bind_relay_run
NOTION_LOCAL_OPS_RELAY_BRIDGE_TIMEOUT=1.5       # seconds, caps the trace POST
NOTION_LOCAL_OPS_RELAY_BINDING_TTL_SECONDS=3600 # seconds, clears old bindings before posting traces

bind_relay_run / clear_relay_run are the agent-facing controls; server_info exposes relay_bridge state (enabled, bound, dropped_traces, …). Disabled or unbound => zero behavior change.

Optional Use Case

If you also want the Notion AI instruction page + project-management workflow, see:

Requirements

  • Python 3.11+
  • FastMCP 3.x (fastmcp>=3.2.4,<4, installed from pyproject.toml)
  • cloudflared
  • A Notion workspace where you can configure an MCP Agent with custom MCP support
  • Optional: codex CLI
  • Optional: claude CLI

Detailed Setup

If you prefer the full step-by-step setup, follow this path:

git clone https://github.com//notion-local-ops-mcp.git
cd notion-local-ops-mcp

cp .env.example .env

Edit .env and set at least:

NOTION_LOCAL_OPS_WORKSPACE_ROOT="/absolute/path/to/workspace"
NOTION_LOCAL_OPS_AUTH_TOKEN="replace-me"

Then run:

./scripts/dev-tunnel.sh

What you should expect:

  • the script creates or reuses .venv
  • the script installs missing or incompatible Python dependencies automatically
  • the script starts the local MCP server on http://127.0.0.1:8766/mcp through a rolling-reload supervisor
  • the script prints a ./scripts/dev-tunnel.sh reload command so you can restart the local server without dropping the tunnel
  • the script prefers cloudflared.local.yml for a named tunnel
  • otherwise it falls back to a cloudflared quick tunnel and prints a public HTTPS URL

Use the printed tunnel URL with /mcp appended in Notion, and use NOTION_LOCAL_OPS_AUTH_TOKEN as the Bearer token.

Manual Install

git clone https://github.com//notion-local-ops-mcp.git
cd notion-local-ops-mcp

python3.11 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Configure

If you are not using the one-command flow, copy .env.example to .env and set at least:

cp .env.example .env
NOTION_LOCAL_OPS_WORKSPACE_ROOT="/absolute/path/to/workspace"
NOTION_LOCAL_OPS_AUTH_TOKEN="replace-me"

Optional:

NOTION_LOCAL_OPS_CODEX_COMMAND="codex"
NOTION_LOCAL_OPS_CLAUDE_COMMAND="claude"
NOTION_LOCAL_OPS_COMMAND_TIMEOUT="120"
NOTION_LOCAL_OPS_DELEGATE_TIMEOUT="1800"
NOTION_LOCAL_OPS_GRACEFUL_SHUTDOWN_SECONDS="30"
NOTION_LOCAL_OPS_LAUNCHD_LABEL_PREFIX="com.notion-local-ops"

Manual Start

source .venv/bin/activate
notion-local-ops-mcp

Local endpoint:

http://127.0.0.1:8766/mcp

One-Command Local Dev Tunnel

Recommended local workflow:

./scripts/dev-tunnel.sh

What it does:

  • reuses or creates .venv
  • installs missing runtime dependencies
  • loads .env from the repo root if present
  • starts notion-local-ops-mcp behind a rolling-reload supervisor
  • keeps the public tunnel stable while ./scripts/dev-tunnel.sh reload swaps in a fresh server process
  • prefers cloudflared.local.yml or cloudflared.local.yaml if present
  • otherwise opens a cloudflared quick tunnel to your local server

Notes:

  • .env is gitignored, so your local token and workspace path stay out of git
  • cloudflared.local.yml is gitignored, so your local named tunnel config stays out of git
  • if NOTION_LOCAL_OPS_WORKSPACE_ROOT is unset, the script defaults it to the repo root
  • if NOTION_LOCAL_OPS_AUTH_TOKEN is unset, the script exits with an error instead of guessing
  • ./scripts/dev-tunnel.sh reload sends SIGHUP to the supervisor and rolls the server process without dropping the public /mcp endpoint
  • for a fresh clone, you do not need to run pip install manually before using this script

Rolling Reload Without Dropping The Tunnel

Once ./scripts/dev-tunnel.sh is already running in one terminal or tmux pane, use this from another shell:

./scripts/dev-tunnel.sh reload

This keeps cloudflared attached to the same local port while the supervisor starts a fresh MCP server process, waits for readiness, and then drains the old one. It is the recommended way to pick up code changes without causing transient 502 responses to Notion.

Persistent macOS launchd install

Use this when the MCP server should stay up even if your shell or tmux pane dies:

./scripts/install-launchd.sh

What gets installed:

  • one LaunchAgent for the local MCP supervisor
  • one LaunchAgent for cloudflared tunnel run
  • one timer-style LaunchAgent that runs launchd-doctor.sh --fix every NOTION_LOCAL_OPS_WATCHDOG_INTERVAL_SECONDS seconds
  • automatic restart via launchd KeepAlive when either process exits
  • health-based restart when local /mcp or public /mcp stays unreachable for NOTION_LOCAL_OPS_DOCTOR_FAILURE_THRESHOLD checks
  • exponential restart backoff starting at NOTION_LOCAL_OPS_DOCTOR_BASE_BACKOFF_SECONDS and capped by NOTION_LOCAL_OPS_DOCTOR_MAX_BACKOFF_SECONDS

Useful commands after install:

./scripts/launchd-status.sh
./scripts/launchd-doctor.sh          # diagnose local vs public /mcp
./scripts/launchd-doctor.sh --fix    # restart only the failed layer
./scripts/launchd-reload.sh           # code-only rolling reload via HUP
./scripts/launchd-restart.sh mcp      # full MCP restart after dependency/env changes
./scripts/launchd-restart.sh all      # restart MCP + cloudflared
./scripts/uninstall-launchd.sh

Update workflow:

  • Python/code-only changes: ./scripts/launchd-reload.sh
  • dependency / .venv / env changes: rerun ./scripts/install-launchd.sh when the rendered plist or dependency constraints may be stale, otherwise use ./scripts/launchd-restart.sh mcp
  • tunnel config changes: ./scripts/launchd-restart.sh cloudflared
  • watchdog interval changes: set NOTION_LOCAL_OPS_WATCHDOG_INTERVAL_SECONDS and rerun ./scripts/install-launchd.sh
  • doctor/backoff changes: set NOTION_LOCAL_OPS_DOCTOR_FAILURE_THRESHOLD, NOTION_LOCAL_OPS_DOCTOR_BASE_BACKOFF_SECONDS, or NOTION_LOCAL_OPS_DOCTOR_MAX_BACKOFF_SECONDS, then rerun ./scripts/install-launchd.sh

Expose With cloudflared

Quick tunnel

cloudflared tunnel --url http://127.0.0.1:8766

Use the generated HTTPS URL with /mcp.

Named tunnel

Copy cloudflared-example.yml to cloudflared.local.yml, fill in your real values, then run:

cp cloudflared-example.yml cloudflared.local.yml
./scripts/dev-tunnel.sh

Or run cloudflared manually:

cloudflared tunnel --config ./cloudflared-example.yml run 

Environment Variables

Variable Required Default
NOTION_LOCAL_OPS_HOST no 127.0.0.1
NOTION_LOCAL_OPS_PORT no 8766
NOTION_LOCAL_OPS_WORKSPACE_ROOT yes home directory
NOTION_LOCAL_OPS_STATE_DIR no ~/.notion-local-ops-mcp
NOTION_LOCAL_OPS_AUTH_TOKEN no empty
NOTION_LOCAL_OPS_AUTH_MODE no shared_token when AUTH_TOKEN is set, otherwise none
NOTION_LOCAL_OPS_PUBLIC_BASE_URL required for OAuth empty
NOTION_LOCAL_OPS_OAUTH_LOGIN_TOKEN no falls back to AUTH_TOKEN
NOTION_LOCAL_OPS_OAUTH_SCOPES no local-ops
NOTION_LOCAL_OPS_OAUTH_TOKEN_TTL_SECONDS no 86400
NOTION_LOCAL_OPS_CLOUDFLARED_CONFIG no empty
NOTION_LOCAL_OPS_TUNNEL_NAME no empty
NOTION_LOCAL_OPS_CODEX_COMMAND no codex
NOTION_LOCAL_OPS_CLAUDE_COMMAND no claude
NOTION_LOCAL_OPS_COMMAND_TIMEOUT no 120
NOTION_LOCAL_OPS_DELEGATE_TIMEOUT no 1800
NOTION_LOCAL_OPS_DEBUG_MCP_LOGGING no 0
NOTION_LOCAL_OPS_GRACEFUL_SHUTDOWN_SECONDS no 30
NOTION_LOCAL_OPS_LAUNCHD_LABEL_PREFIX no com.notion-local-ops

MCP Tools

  • list_files: list files and directories with pagination; excludes hidden/junk dirs and respects .gitignore by default
  • list_skills: discover project and global skills with name and description summaries
  • search: canonical query tool that unifies glob path search, regex grep, and literal substring search; excludes hidden and .gitignored paths by default and supports regex/text search against a single file path
  • read_text: canonical single/batch reader with line-based pagination (start_line/line_limit), optional include_line_numbers, and language hint
  • write_file: write full file content, supports dry_run
  • apply_patch: default edit tool for existing files; uses *** Begin Patch / *** Update File syntax, rejects pure-context hunks, requires unique context matches, and returns per-file change stats/warnings
  • server_info: inspect runtime config and the registered MCP tool list
  • set_default_cwd: set session default working directory for subsequent calls
  • get_default_cwd: inspect current session/effective working directory
  • git_status: structured repository status (use when cwd is inside a git repo)
  • git_diff: structured diff output grouped by file with per-file truncation
  • git_commit: stage selected paths or all changes and create a commit (amend / allow_empty / author / sign_off / dry_run)
  • git_log: recent commit history
  • git_show: inspect metadata and per-file diff for a commit/ref
  • git_blame: line-level blame metadata for a file/range
  • run_command: run local shell commands, optionally in background
  • run_command_stream: start a background shell job and poll output by task id; this is the preferred route for long tests/builds/installs
  • delegate_task: send a task to local codex or claude-code, with optional goal, acceptance_criteria, verification_commands, and commit_mode
  • get_task: read task status and output tail
  • wait_task: block until a delegated or background shell task completes or times out
  • cancel_task: stop a delegated or background shell task
  • purge_tasks: clean old task artifacts from STATE_DIR/tasks with dry-run support

Relay bridge controls (see Relay Bridge):

  • bind_relay_run: bind the current process to a relay run so subsequent tool calls are mirrored
  • clear_relay_run: unbind; equivalent to bind_relay_run with a null request_id

Debugging Notion / MCP handshake issues

If a client appears connected but hangs during initialize, tools/list, or tool calls, enable verbose MCP request logging:

NOTION_LOCAL_OPS_DEBUG_MCP_LOGGING=1 ./scripts/dev-tunnel.sh

When enabled, the server log includes MCP_DEBUG lines with:

  • HTTP method and path
  • session id hint
  • JSON-RPC method
  • tool name for tools/call
  • truncated arguments summary for tools/call
  • response status and duration

Verify

source .venv/bin/activate
pytest -q
python -m compileall src tests

Local MCP call simulation tests

Use these to simulate real MCP client/server flows locally (initialize + call_tool + wait_task):

source .venv/bin/activate
pytest -q tests/test_server_transport.py tests/test_concurrent_clients.py tests/test_mcp_local_simulation.py

Troubleshooting

Notion says it cannot connect

  • Check the URL ends with /mcp
  • Check the auth type is Bearer
  • Check the token matches NOTION_LOCAL_OPS_AUTH_TOKEN
  • Check cloudflared is still running
  • If you installed the macOS LaunchAgents, start with ./scripts/launchd-status.sh
  • If you are updating the server while users are connected, prefer ./scripts/dev-tunnel.sh reload or ./scripts/launchd-reload.sh over killing the whole tunnel session

MCP endpoint works locally but not over tunnel

  • Retry with a named tunnel instead of a quick tunnel
  • Confirm a real MCP client can list tools from /mcp, for example:
source .venv/bin/activate
fastmcp list http://127.0.0.1:8766/mcp

Notion saw a temporary 502 while you were restarting

  • A Cloudflare 502 during restart usually means the origin was briefly unavailable, not that Cloudflare blocked the request
  • If this happened while you manually killed the tmux pane, switch to ./scripts/dev-tunnel.sh reload so the supervisor overlaps the new server with the old one
  • Check the newest notion-local-ops-mcp-server.*.log file to confirm the replacement process reached readiness before the old one drained

Logs show repeated 404s

  • If the 404 is for GET /, the configured URL likely missed the /mcp suffix
  • If the 404/405 happens while using /mcp, upgrade to a build that serves streamable HTTP on /mcp

delegate_task fails

  • Check codex --help
  • Check claude --help
  • Set NOTION_LOCAL_OPS_CODEX_COMMAND or NOTION_LOCAL_OPS_CLAUDE_COMMAND if needed
View this README on GitHub

安装

This server does not publish a one-line install command.

Open the repository installation guide