Home · Skills · Development · Agent
Notion MCP server
Notion's official server: search, read and edit pages and databases in your workspace.
How to install
- Runs on your computer — needs Node. Works in Claude Code, Claude Desktop and Cursor.
- Run the Claude Code line, or paste the JSON into your app's MCP config and fill in the placeholder values.
- Restart the app, then ask something that needs the tool.
claude mcp add notion -e NOTION_TOKEN=ntn_your_integration_token -- npx -y @notionhq/notion-mcp-server{
"mcpServers": {
"notion": {
"command": "npx",
"args": [
"-y",
"@notionhq/notion-mcp-server"
],
"env": {
"NOTION_TOKEN": "ntn_your_integration_token"
}
}
}
}Create an internal integration at notion.so/profile/integrations, then share the pages it may read with that integration.
This one runs on your machine and can reach your files. Read the README below before you connect it.
Not working?
- Check which app you pasted it into — the steps above name the right one.
- Some skills need the paid tier of Claude or ChatGPT.
Paste into Claude, ChatGPT or Cursor.
Show the full text529 lines
Notion MCP Server
[!NOTE]
For the best experience, use Remote Notion MCP, our official hosted MCP server. This repository is a separate, self-hosted MCP server implementation that is no longer actively maintained or supported. Please use Remote Notion MCP instead. It is purpose-built to give AI agents faster results using far fewer tokens.
Remote Notion MCP can search your workspace and connected apps semantically, read and edit pages in Markdown, and return only the most relevant context. That means less time waiting, less context-window usage, and lower token costs. It also uses OAuth and automatically respects each user's existing Notion permissions—without API tokens, JSON configuration, manual page sharing, or a local server to maintain.
Feature Remote Notion MCP This project (local) Fast, hosted experience ✅ Runs and updates locally Token-efficient responses ✅ Limited Powerful tools tailored for AI agents ✅ Basic API-derived tools Semantic search across your Notion workspace ✅ Keyword search only AI Connector search across connected apps ✅ Not available Markdown-native page reading and editing ✅ Limited to two page-content tools Seamless OAuth setup ✅ Manual token and JSON configuration Respects each user's existing Notion permissions ✅ Manual integration permissions and page sharing Active support and ongoing improvements ✅ Not actively supported Learn more and get started in the Remote Notion MCP documentation.
We are prioritizing, and only providing active support for, Remote Notion MCP. As a result:
- We may sunset this local MCP server repository in the future.
- Issues and pull requests here are not actively monitored.
- Please do not file issues relating to the remote MCP here; instead, contact Notion support.
This project implements an MCP server for the Notion API.
⚠️ Version 2.0.0 breaking changes
Version 2.0.0 migrates to the Notion API 2025-09-03 which introduces data sources as the primary abstraction for databases.
What changed
Removed tools (3):
post-database-query- replaced byquery-data-sourceupdate-a-database- replaced byupdate-a-data-sourcecreate-a-database- replaced bycreate-a-data-source
New tools (7):
query-data-source- Query a data source (database) with filters and sortsretrieve-a-data-source- Get metadata and schema for a data sourceupdate-a-data-source- Update data source propertiescreate-a-data-source- Create a new data sourcelist-data-source-templates- List available templates in a data sourcemove-page- Move a page to a different parent locationretrieve-a-database- Get database metadata including its data source IDs
Parameter changes:
- All database operations now use
data_source_idinstead ofdatabase_id - Search filter values changed from
["page", "database"]to["page", "data_source"] - Page creation now supports both
page_idanddatabase_idparents (for data sources)
Do I need to migrate?
No code changes required. MCP tools are discovered automatically when the server starts. When you upgrade to v2.0.0, AI clients will automatically see the new tool names and parameters. The old database tools are no longer available.
If you have hardcoded tool names or prompts that reference the old database tools, update them to use the new data source tools:
| Old Tool (v1.x) | New Tool (v2.0) | Parameter Change |
|---|---|---|
post-database-query |
query-data-source |
database_id → data_source_id |
update-a-database |
update-a-data-source |
database_id → data_source_id |
create-a-database |
create-a-data-source |
No change (uses parent.page_id) |
Note:
retrieve-a-databaseis still available and returns database metadata including the list of data source IDs. Useretrieve-a-data-sourceto get the schema and properties of a specific data source.
Total tools now: 22 (was 19 in v1.x)
Page content as Markdown
The server exposes two tools for working with page content as enhanced Markdown instead of block JSON, which is significantly more token-efficient for AI agents:
retrieve-page-markdown— Read a page's full content as Markdown (GET /v1/pages/{page_id}/markdown). Passinclude_transcript: trueto inline meeting-note transcripts.update-page-markdown— Edit a page's content with Markdown (PATCH /v1/pages/{page_id}/markdown). Preferreplace_contentto overwrite the whole page, orupdate_contentfor targeted find-and-replace edits.
These endpoints require Notion API version 2026-03-11. The server now sources the Notion-Version header per operation from the OpenAPI spec, so these tools use 2026-03-11 while the rest of the API continues to use 2025-09-03 — no configuration needed. If you set Notion-Version yourself via OPENAPI_MCP_HEADERS, your value takes precedence for every tool.
Installation
1. Setting up integration in Notion
Go to https://www.notion.so/profile/integrations and create a new internal integration or select an existing one.
Creating a Notion Integration token
While we limit the scope of Notion API's exposed (for example, you will not be able to delete databases via MCP), there is a non-zero risk to workspace data by exposing it to LLMs. Security-conscious users may want to further configure the Integration's Capabilities.
For example, you can create a read-only integration token by giving only "Read content" access from the "Configuration" tab:
Notion Integration Token Capabilities showing Read content checked
2. Connecting content to integration
Ensure relevant pages and databases are connected to your integration.
To do this, visit the Access tab in your internal integration settings. Edit access and select the pages you'd like to use.
Integration Access tab
Edit integration access
Alternatively, you can grant page access individually. You'll need to visit the target page, and click on the 3 dots, and select "Connect to integration".
Adding Integration Token to Notion Connections
3. Adding MCP config to your client
Using npm
Cursor & Claude
Add the following to your .cursor/mcp.json or claude_desktop_config.json (MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json)
Option 1: Using NOTION_TOKEN (recommended)
{
"mcpServers": {
"notionApi": {
"command": "npx",
"args": ["-y", "@notionhq/notion-mcp-server"],
"env": {
"NOTION_TOKEN": "ntn_****"
}
}
}
}
Option 2: Using OPENAPI_MCP_HEADERS (for advanced use cases)
{
"mcpServers": {
"notionApi": {
"command": "npx",
"args": ["-y", "@notionhq/notion-mcp-server"],
"env": {
"OPENAPI_MCP_HEADERS": "{\"Authorization\": \"Bearer ntn_****\", \"Notion-Version\": \"2025-09-03\" }"
}
}
}
}
Zed
Add the following to your settings.json
{
"context_servers": {
"some-context-server": {
"command": {
"path": "npx",
"args": ["-y", "@notionhq/notion-mcp-server"],
"env": {
"OPENAPI_MCP_HEADERS": "{\"Authorization\": \"Bearer ntn_****\", \"Notion-Version\": \"2025-09-03\" }"
}
},
"settings": {}
}
}
}
GitHub Copilot CLI
Use the Copilot CLI to interactively add the MCP server:
/mcp add
Alternatively, create or edit the configuration file ~/.copilot/mcp-config.json and add:
{
"mcpServers": {
"notionApi": {
"command": "npx",
"args": ["-y", "@notionhq/notion-mcp-server"],
"env": {
"NOTION_TOKEN": "ntn_****"
}
}
}
}
For more information, see the Copilot CLI documentation.
Using Docker
There are two options for running the MCP server with Docker:
Option 1: Using the official Docker Hub image
Add the following to your .cursor/mcp.json or claude_desktop_config.json
Using NOTION_TOKEN (recommended):
{
"mcpServers": {
"notionApi": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e", "NOTION_TOKEN",
"mcp/notion"
],
"env": {
"NOTION_TOKEN": "ntn_****"
}
}
}
}
Using OPENAPI_MCP_HEADERS (for advanced use cases):
{
"mcpServers": {
"notionApi": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e", "OPENAPI_MCP_HEADERS",
"mcp/notion"
],
"env": {
"OPENAPI_MCP_HEADERS": "{\"Authorization\":\"Bearer ntn_****\",\"Notion-Version\":\"2025-09-03\"}"
}
}
}
}
This approach:
- Uses the official Docker Hub image
- Properly handles JSON escaping via environment variables
- Provides a more reliable configuration method
Option 2: Building the Docker image locally
You can also build and run the Docker image locally. First, build the Docker image:
docker compose build
Then, add the following to your .cursor/mcp.json or claude_desktop_config.json
Using NOTION_TOKEN (recommended):
{
"mcpServers": {
"notionApi": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"NOTION_TOKEN=ntn_****",
"notion-mcp-server"
]
}
}
}
Using OPENAPI_MCP_HEADERS (for advanced use cases):
{
"mcpServers": {
"notionApi": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"OPENAPI_MCP_HEADERS={\"Authorization\": \"Bearer ntn_****\", \"Notion-Version\": \"2025-09-03\"}",
"notion-mcp-server"
]
}
}
}
Don't forget to replace ntn_**** with your integration secret. Find it from your integration configuration tab:
Transport options
The Notion MCP Server supports two transport modes:
STDIO transport (default)
The default transport mode uses standard input/output for communication. This is the standard MCP transport used by most clients like Claude Desktop.
# Run with default stdio transport
npx @notionhq/notion-mcp-server
# Or explicitly specify stdio
npx @notionhq/notion-mcp-server --transport stdio
Streamable HTTP transport
For web-based applications or clients that prefer HTTP communication, you can use the Streamable HTTP transport:
# Run with Streamable HTTP transport on port 3000 (default)
npx @notionhq/notion-mcp-server --transport http
# Run on a custom port
npx @notionhq/notion-mcp-server --transport http --port 8080
# Bind to a different host. The default is 127.0.0.1.
npx @notionhq/notion-mcp-server --transport http --host 0.0.0.0
# Run with a custom authentication token
npx @notionhq/notion-mcp-server --transport http --auth-token "your-secret-token"
When using Streamable HTTP transport, the server will be available at http://127.0.0.1:<port>/mcp by default.
Authentication
The Streamable HTTP transport requires bearer token authentication for security. You have three options:
Option 1: Auto-generated token (only for development)
npx @notionhq/notion-mcp-server --transport http
The server will generate a secure random token and write it to a file with restricted permissions:
Generated auth token written to: /tmp/.notion-mcp-auth-token-12345
Option 2: Custom token via command line (recommended for production)
npx @notionhq/notion-mcp-server --transport http --auth-token "your-secret-token"
Option 3: Custom token via environment variable (recommended for production)
AUTH_TOKEN="your-secret-token" npx @notionhq/notion-mcp-server --transport http
The command line argument --auth-token takes precedence over the AUTH_TOKEN environment variable if both are provided.
Unsafe option: disable HTTP authentication
You can disable bearer token authentication only with the explicit unsafe flag:
npx @notionhq/notion-mcp-server --transport http --unsafe-disable-auth
WARNING: --unsafe-disable-auth is unsafe. The server may be reachable to pages you visit via DNS rebinding. Only use it on an isolated network.
When authentication is disabled, the server enables DNS rebinding protection by checking the Host and Origin headers against the configured local host and loopback hosts. The previous --disable-auth flag is still accepted as a deprecated alias, but it will print a warning.
Making HTTP requests
All requests to the Streamable HTTP transport must include the bearer token in the Authorization header:
# Example request
curl -H "Authorization: Bearer your-token-here" \
-H "Content-Type: application/json" \
-H "mcp-session-id: your-session-id" \
-d '{"jsonrpc": "2.0", "method": "initialize", "params": {}, "id": 1}' \
http://localhost:3000/mcp
Note: Make sure to set either the NOTION_TOKEN environment variable (recommended) or the OPENAPI_MCP_HEADERS environment variable with your Notion integration token when using either transport mode.
Serving multiple integrations (per-request token passthrough)
By default the server authenticates to Notion with a single token baked in at startup, which locks one deployment to one Notion integration. To let a single deployment serve multiple integrations, enable token passthrough so each client supplies its own Notion integration token per connection:
# Enable per-request Notion tokens (flag or ENABLE_TOKEN_PASSTHROUGH=true)
npx @notionhq/notion-mcp-server --transport http --enable-token-passthrough
Clients then send their Notion token on the initialize request using the
dedicated Notion-Token header:
curl -H "Authorization: Bearer <server-auth-token>" \
-H "Notion-Token: ntn_****" \
-H "Content-Type: application/json" \
-d '{"jsonrpc": "2.0", "method": "initialize", "params": {}, "id": 1}' \
http://localhost:3000/mcp
How the token is resolved for each connection, in order:
- The
Notion-Tokenheader (preferred — unambiguous, and works alongside the server's ownAuthorizationgateway auth). If present it must be a valid Notion token, otherwise the request is rejected with401. Authorization: Bearer ntn_****— only when the server's own bearer auth is turned off (--unsafe-disable-auth), so the header is free to carry the Notion token directly.- Otherwise the startup env token (
NOTION_TOKEN/OPENAPI_MCP_HEADERS), if set, so passthrough and a default integration can coexist on one deployment.
Notes:
- Only values with a Notion token prefix (
ntn_, legacysecret_) are treated as Notion tokens, so the server's gateway secret and a tenant's Notion token never collide. - Each token is bound to its MCP session; tokens are never logged (only a redacted prefix is emitted).
- This is a deliberate token-passthrough setup. Always deploy it over TLS, and
prefer keeping the server's own bearer auth (
--auth-token) enabled as a gateway in front of multi-tenant traffic.
Examples
- Using the following instruction
Comment "Hello MCP" on page "Getting started"
AI will correctly plan two API calls, v1/search and v1/comments, to achieve the task
- Similarly, the following instruction will result in a new page named "Notion MCP" added to parent page "Development"
Add a page titled "Notion MCP" to page "Development"
- You may also reference content ID directly
Get the content of page 1a6b35e6e67f802fa7e1d27686f017f2
Development
Build & test
npm run build
npm test
Execute
npx -y --prefix /path/to/local/notion-mcp-server @notionhq/notion-mcp-server
Testing changes locally in Cursor:
- Run
npm linkcommand from repository root to create a machine-global symlink to thenotion-mcp-serverpackage. - Merge the configuration snippet below into Cursor's
mcp.json(or other MCP client you want to test with). - (Cleanup) run
npm unlinkfrom repository root.
{
"mcpServers": {
"notion-local-package": {
"command": "notion-mcp-server",
"env": {
"NOTION_TOKEN": "ntn_..."
}
}
}
}
Publish
npm login
npm publish --access public
| 1 | # Notion MCP Server |
| 2 | |
| 3 | > [!NOTE] |
| 4 | > |
| 5 | > For the best experience, use **[Remote Notion MCP]**, |
| 6 | > our official hosted MCP server. **This repository is a separate, self-hosted MCP |
| 7 | > server implementation that is no longer actively maintained or supported. Please |
| 8 | > use Remote Notion MCP instead.** It is purpose-built to give AI agents |
| 9 | > **faster results using far fewer tokens**. |
| 10 | > |
| 11 | > Remote Notion MCP can search your workspace and connected apps semantically, read and |
| 12 | > edit pages in Markdown, and return only the most relevant context. That means less |
| 13 | > time waiting, less context-window usage, and lower token costs. It also uses OAuth |
| 14 | > and automatically respects each user's existing Notion permissions—without API |
| 15 | > tokens, JSON configuration, manual page sharing, or a local server to maintain. |
| 16 | > |
| 17 | > | Feature | Remote Notion MCP | This project (local) | |
| 18 | > | --- | :---: | :---: | |
| 19 | > | **Fast, hosted experience** | ✅ | Runs and updates locally | |
| 20 | > | **Token-efficient responses** | ✅ | Limited | |
| 21 | > | Powerful tools tailored for AI agents | ✅ | Basic API-derived tools | |
| 22 | > | Semantic search across your Notion workspace | ✅ | Keyword search only | |
| 23 | > | AI Connector search across connected apps | ✅ | Not available | |
| 24 | > | Markdown-native page reading and editing | ✅ | Limited to two page-content tools | |
| 25 | > | Seamless OAuth setup | ✅ | Manual token and JSON configuration | |
| 26 | > | Respects each user's existing Notion permissions | ✅ | Manual integration permissions and page sharing | |
| 27 | > | Active support and ongoing improvements | ✅ | Not actively supported | |
| 28 | > |
| 29 | > Learn more and get started in the [Remote Notion MCP documentation]. |
| 30 | > |
| 31 | > We are prioritizing, and only providing active support for, **Remote Notion MCP**. As a result: |
| 32 | > |
| 33 | > - We may sunset this local MCP server repository in the future. |
| 34 | > - Issues and pull requests here are not actively monitored. |
| 35 | > - Please do not file issues relating to the remote MCP here; instead, contact Notion support. |
| 36 | |
| 37 | ![notion-mcp-sm] |
| 38 | |
| 39 | This project implements an [MCP server] for the [Notion API]. |
| 40 | |
| 41 | ![mcp-demo] |
| 42 | |
| 43 | |
| 44 | |
| 45 | ## ⚠️ Version 2.0.0 breaking changes |
| 46 | |
| 47 | **Version 2.0.0 migrates to the Notion API 2025-09-03** which introduces data sources as the primary abstraction for databases. |
| 48 | |
| 49 | ### What changed |
| 50 | |
| 51 | **Removed tools (3):** |
| 52 | |
| 53 | `post-database-query` - replaced by `query-data-source` |
| 54 | `update-a-database` - replaced by `update-a-data-source` |
| 55 | `create-a-database` - replaced by `create-a-data-source` |
| 56 | |
| 57 | **New tools (7):** |
| 58 | |
| 59 | `query-data-source` - Query a data source (database) with filters and sorts |
| 60 | `retrieve-a-data-source` - Get metadata and schema for a data source |
| 61 | `update-a-data-source` - Update data source properties |
| 62 | `create-a-data-source` - Create a new data source |
| 63 | `list-data-source-templates` - List available templates in a data source |
| 64 | `move-page` - Move a page to a different parent location |
| 65 | `retrieve-a-database` - Get database metadata including its data source IDs |
| 66 | |
| 67 | **Parameter changes:** |
| 68 | |
| 69 | All database operations now use `data_source_id` instead of `database_id` |
| 70 | Search filter values changed from `["page", "database"]` to `["page", "data_source"]` |
| 71 | Page creation now supports both `page_id` and `database_id` parents (for data sources) |
| 72 | |
| 73 | ### Do I need to migrate? |
| 74 | |
| 75 | **No code changes required.** MCP tools are discovered automatically when the server starts. When you upgrade to v2.0.0, AI clients will automatically see the new tool names and parameters. The old database tools are no longer available. |
| 76 | |
| 77 | If you have hardcoded tool names or prompts that reference the old database tools, update them to use the new data source tools: |
| 78 | |
| 79 | | Old Tool (v1.x) | New Tool (v2.0) | Parameter Change | |
| 80 | | -------------- | --------------- | ---------------- | |
| 81 | | `post-database-query` | `query-data-source` | `database_id` → `data_source_id` | |
| 82 | | `update-a-database` | `update-a-data-source` | `database_id` → `data_source_id` | |
| 83 | | `create-a-database` | `create-a-data-source` | No change (uses `parent.page_id`) | |
| 84 | |
| 85 | > **Note:** `retrieve-a-database` is still available and returns database metadata including the list of data source IDs. Use `retrieve-a-data-source` to get the schema and properties of a specific data source. |
| 86 | |
| 87 | **Total tools now: 22** (was 19 in v1.x) |
| 88 | |
| 89 | |
| 90 | |
| 91 | ## Page content as Markdown |
| 92 | |
| 93 | The server exposes two tools for working with page content as enhanced Markdown instead of block JSON, which is significantly more token-efficient for AI agents: |
| 94 | |
| 95 | `retrieve-page-markdown` — Read a page's full content as Markdown (`GET /v1/pages/{page_id}/markdown`). Pass `include_transcript: true` to inline meeting-note transcripts. |
| 96 | `update-page-markdown` — Edit a page's content with Markdown (`PATCH /v1/pages/{page_id}/markdown`). Prefer `replace_content` to overwrite the whole page, or `update_content` for targeted find-and-replace edits. |
| 97 | |
| 98 | These endpoints require Notion API version `2026-03-11`. The server now sources the `Notion-Version` header **per operation** from the OpenAPI spec, so these tools use `2026-03-11` while the rest of the API continues to use `2025-09-03` — no configuration needed. If you set `Notion-Version` yourself via `OPENAPI_MCP_HEADERS`, your value takes precedence for every tool. |
| 99 | |
| 100 | |
| 101 | |
| 102 | ### Installation |
| 103 | |
| 104 | #### 1. Setting up integration in Notion |
| 105 | |
| 106 | Go to [https://www.notion.so/profile/integrations] and create a new **internal** integration or select an existing one. |
| 107 | |
| 108 | ![Creating a Notion Integration token] |
| 109 | |
| 110 | While we limit the scope of Notion API's exposed (for example, you will not be able to delete databases via MCP), there is a non-zero risk to workspace data by exposing it to LLMs. Security-conscious users may want to further configure the Integration's _Capabilities_. |
| 111 | |
| 112 | For example, you can create a read-only integration token by giving only "Read content" access from the "Configuration" tab: |
| 113 | |
| 114 | ![Notion Integration Token Capabilities showing Read content checked] |
| 115 | |
| 116 | #### 2. Connecting content to integration |
| 117 | |
| 118 | Ensure relevant pages and databases are connected to your integration. |
| 119 | |
| 120 | To do this, visit the **Access** tab in your internal integration settings. Edit access and select the pages you'd like to use. |
| 121 | |
| 122 | ![Integration Access tab] |
| 123 | |
| 124 | ![Edit integration access] |
| 125 | |
| 126 | Alternatively, you can grant page access individually. You'll need to visit the target page, and click on the 3 dots, and select "Connect to integration". |
| 127 | |
| 128 | ![Adding Integration Token to Notion Connections] |
| 129 | |
| 130 | #### 3. Adding MCP config to your client |
| 131 | |
| 132 | ##### Using npm |
| 133 | |
| 134 | ###### Cursor & Claude |
| 135 | |
| 136 | Add the following to your `.cursor/mcp.json` or `claude_desktop_config.json` (MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`) |
| 137 | |
| 138 | ###### Option 1: Using NOTION_TOKEN (recommended) |
| 139 | |
| 140 | |
| 141 | { |
| 142 | "mcpServers": { |
| 143 | "notionApi": { |
| 144 | "command": "npx", |
| 145 | "args": ["-y", "@notionhq/notion-mcp-server"], |
| 146 | "env": { |
| 147 | "NOTION_TOKEN": "ntn_****" |
| 148 | } |
| 149 | } |
| 150 | } |
| 151 | } |
| 152 | |
| 153 | |
| 154 | ###### Option 2: Using OPENAPI_MCP_HEADERS (for advanced use cases) |
| 155 | |
| 156 | |
| 157 | { |
| 158 | "mcpServers": { |
| 159 | "notionApi": { |
| 160 | "command": "npx", |
| 161 | "args": ["-y", "@notionhq/notion-mcp-server"], |
| 162 | "env": { |
| 163 | "OPENAPI_MCP_HEADERS": "{\"Authorization\": \"Bearer ntn_****\", \"Notion-Version\": \"2025-09-03\" }" |
| 164 | } |
| 165 | } |
| 166 | } |
| 167 | } |
| 168 | |
| 169 | |
| 170 | ###### Zed |
| 171 | |
| 172 | Add the following to your `settings.json` |
| 173 | |
| 174 | |
| 175 | { |
| 176 | "context_servers": { |
| 177 | "some-context-server": { |
| 178 | "command": { |
| 179 | "path": "npx", |
| 180 | "args": ["-y", "@notionhq/notion-mcp-server"], |
| 181 | "env": { |
| 182 | "OPENAPI_MCP_HEADERS": "{\"Authorization\": \"Bearer ntn_****\", \"Notion-Version\": \"2025-09-03\" }" |
| 183 | } |
| 184 | }, |
| 185 | "settings": {} |
| 186 | } |
| 187 | } |
| 188 | } |
| 189 | |
| 190 | |
| 191 | ###### GitHub Copilot CLI |
| 192 | |
| 193 | Use the Copilot CLI to interactively add the MCP server: |
| 194 | |
| 195 | |
| 196 | /mcp add |
| 197 | |
| 198 | |
| 199 | Alternatively, create or edit the configuration file `~/.copilot/mcp-config.json` and add: |
| 200 | |
| 201 | |
| 202 | { |
| 203 | "mcpServers": { |
| 204 | "notionApi": { |
| 205 | "command": "npx", |
| 206 | "args": ["-y", "@notionhq/notion-mcp-server"], |
| 207 | "env": { |
| 208 | "NOTION_TOKEN": "ntn_****" |
| 209 | } |
| 210 | } |
| 211 | } |
| 212 | } |
| 213 | |
| 214 | |
| 215 | For more information, see the [Copilot CLI documentation]. |
| 216 | |
| 217 | ##### Using Docker |
| 218 | |
| 219 | There are two options for running the MCP server with Docker: |
| 220 | |
| 221 | ###### Option 1: Using the official Docker Hub image |
| 222 | |
| 223 | Add the following to your `.cursor/mcp.json` or `claude_desktop_config.json` |
| 224 | |
| 225 | Using NOTION_TOKEN (recommended): |
| 226 | |
| 227 | |
| 228 | { |
| 229 | "mcpServers": { |
| 230 | "notionApi": { |
| 231 | "command": "docker", |
| 232 | "args": [ |
| 233 | "run", |
| 234 | "--rm", |
| 235 | "-i", |
| 236 | "-e", "NOTION_TOKEN", |
| 237 | "mcp/notion" |
| 238 | ], |
| 239 | "env": { |
| 240 | "NOTION_TOKEN": "ntn_****" |
| 241 | } |
| 242 | } |
| 243 | } |
| 244 | } |
| 245 | |
| 246 | |
| 247 | Using OPENAPI_MCP_HEADERS (for advanced use cases): |
| 248 | |
| 249 | |
| 250 | { |
| 251 | "mcpServers": { |
| 252 | "notionApi": { |
| 253 | "command": "docker", |
| 254 | "args": [ |
| 255 | "run", |
| 256 | "--rm", |
| 257 | "-i", |
| 258 | "-e", "OPENAPI_MCP_HEADERS", |
| 259 | "mcp/notion" |
| 260 | ], |
| 261 | "env": { |
| 262 | "OPENAPI_MCP_HEADERS": "{\"Authorization\":\"Bearer ntn_****\",\"Notion-Version\":\"2025-09-03\"}" |
| 263 | } |
| 264 | } |
| 265 | } |
| 266 | } |
| 267 | |
| 268 | |
| 269 | This approach: |
| 270 | |
| 271 | Uses the official Docker Hub image |
| 272 | Properly handles JSON escaping via environment variables |
| 273 | Provides a more reliable configuration method |
| 274 | |
| 275 | ###### Option 2: Building the Docker image locally |
| 276 | |
| 277 | You can also build and run the Docker image locally. First, build the Docker image: |
| 278 | |
| 279 | |
| 280 | docker compose build |
| 281 | |
| 282 | |
| 283 | Then, add the following to your `.cursor/mcp.json` or `claude_desktop_config.json` |
| 284 | |
| 285 | Using NOTION_TOKEN (recommended): |
| 286 | |
| 287 | |
| 288 | { |
| 289 | "mcpServers": { |
| 290 | "notionApi": { |
| 291 | "command": "docker", |
| 292 | "args": [ |
| 293 | "run", |
| 294 | "--rm", |
| 295 | "-i", |
| 296 | "-e", |
| 297 | "NOTION_TOKEN=ntn_****", |
| 298 | "notion-mcp-server" |
| 299 | ] |
| 300 | } |
| 301 | } |
| 302 | } |
| 303 | |
| 304 | |
| 305 | Using OPENAPI_MCP_HEADERS (for advanced use cases): |
| 306 | |
| 307 | |
| 308 | { |
| 309 | "mcpServers": { |
| 310 | "notionApi": { |
| 311 | "command": "docker", |
| 312 | "args": [ |
| 313 | "run", |
| 314 | "--rm", |
| 315 | "-i", |
| 316 | "-e", |
| 317 | "OPENAPI_MCP_HEADERS={\"Authorization\": \"Bearer ntn_****\", \"Notion-Version\": \"2025-09-03\"}", |
| 318 | "notion-mcp-server" |
| 319 | ] |
| 320 | } |
| 321 | } |
| 322 | } |
| 323 | |
| 324 | |
| 325 | Don't forget to replace `ntn_****` with your integration secret. Find it from your integration configuration tab: |
| 326 | |
| 327 | ![Copying your Integration token from the Configuration tab in the developer portal] |
| 328 | |
| 329 | ### Transport options |
| 330 | |
| 331 | The Notion MCP Server supports two transport modes: |
| 332 | |
| 333 | #### STDIO transport (default) |
| 334 | |
| 335 | The default transport mode uses standard input/output for communication. This is the standard MCP transport used by most clients like Claude Desktop. |
| 336 | |
| 337 | |
| 338 | # Run with default stdio transport |
| 339 | npx @notionhq/notion-mcp-server |
| 340 | |
| 341 | # Or explicitly specify stdio |
| 342 | npx @notionhq/notion-mcp-server --transport stdio |
| 343 | |
| 344 | |
| 345 | #### Streamable HTTP transport |
| 346 | |
| 347 | For web-based applications or clients that prefer HTTP communication, you can use the Streamable HTTP transport: |
| 348 | |
| 349 | |
| 350 | # Run with Streamable HTTP transport on port 3000 (default) |
| 351 | npx @notionhq/notion-mcp-server --transport http |
| 352 | |
| 353 | # Run on a custom port |
| 354 | npx @notionhq/notion-mcp-server --transport http --port 8080 |
| 355 | |
| 356 | # Bind to a different host. The default is 127.0.0.1. |
| 357 | npx @notionhq/notion-mcp-server --transport http --host 0.0.0.0 |
| 358 | |
| 359 | # Run with a custom authentication token |
| 360 | npx @notionhq/notion-mcp-server --transport http --auth-token "your-secret-token" |
| 361 | |
| 362 | |
| 363 | When using Streamable HTTP transport, the server will be available at `http://127.0.0.1:<port>/mcp` by default. |
| 364 | |
| 365 | ##### Authentication |
| 366 | |
| 367 | The Streamable HTTP transport requires bearer token authentication for security. You have three options: |
| 368 | |
| 369 | ###### Option 1: Auto-generated token (only for development) |
| 370 | |
| 371 | |
| 372 | npx @notionhq/notion-mcp-server --transport http |
| 373 | |
| 374 | |
| 375 | The server will generate a secure random token and write it to a file with restricted permissions: |
| 376 | |
| 377 | |
| 378 | Generated auth token written to: /tmp/.notion-mcp-auth-token-12345 |
| 379 | |
| 380 | |
| 381 | ###### Option 2: Custom token via command line (recommended for production) |
| 382 | |
| 383 | |
| 384 | npx @notionhq/notion-mcp-server --transport http --auth-token "your-secret-token" |
| 385 | |
| 386 | |
| 387 | ###### Option 3: Custom token via environment variable (recommended for production) |
| 388 | |
| 389 | |
| 390 | AUTH_TOKEN="your-secret-token" npx @notionhq/notion-mcp-server --transport http |
| 391 | |
| 392 | |
| 393 | The command line argument `--auth-token` takes precedence over the `AUTH_TOKEN` environment variable if both are provided. |
| 394 | |
| 395 | ###### Unsafe option: disable HTTP authentication |
| 396 | |
| 397 | You can disable bearer token authentication only with the explicit unsafe flag: |
| 398 | |
| 399 | |
| 400 | npx @notionhq/notion-mcp-server --transport http --unsafe-disable-auth |
| 401 | |
| 402 | |
| 403 | WARNING: `--unsafe-disable-auth` is unsafe. The server may be reachable to pages you visit via DNS rebinding. Only use it on an isolated network. |
| 404 | |
| 405 | When authentication is disabled, the server enables DNS rebinding protection by checking the `Host` and `Origin` headers against the configured local host and loopback hosts. The previous `--disable-auth` flag is still accepted as a deprecated alias, but it will print a warning. |
| 406 | |
| 407 | ##### Making HTTP requests |
| 408 | |
| 409 | All requests to the Streamable HTTP transport must include the bearer token in the Authorization header: |
| 410 | |
| 411 | |
| 412 | # Example request |
| 413 | curl -H "Authorization: Bearer your-token-here" \ |
| 414 | -H "Content-Type: application/json" \ |
| 415 | -H "mcp-session-id: your-session-id" \ |
| 416 | -d '{"jsonrpc": "2.0", "method": "initialize", "params": {}, "id": 1}' \ |
| 417 | http://localhost:3000/mcp |
| 418 | |
| 419 | |
| 420 | **Note:** Make sure to set either the `NOTION_TOKEN` environment variable (recommended) or the `OPENAPI_MCP_HEADERS` environment variable with your Notion integration token when using either transport mode. |
| 421 | |
| 422 | ##### Serving multiple integrations (per-request token passthrough) |
| 423 | |
| 424 | By default the server authenticates to Notion with a single token baked in at |
| 425 | startup, which locks one deployment to one Notion integration. To let a single |
| 426 | deployment serve **multiple** integrations, enable token passthrough so each |
| 427 | client supplies its own Notion integration token per connection: |
| 428 | |
| 429 | |
| 430 | # Enable per-request Notion tokens (flag or ENABLE_TOKEN_PASSTHROUGH=true) |
| 431 | npx @notionhq/notion-mcp-server --transport http --enable-token-passthrough |
| 432 | |
| 433 | |
| 434 | Clients then send their Notion token on the **initialize** request using the |
| 435 | dedicated `Notion-Token` header: |
| 436 | |
| 437 | |
| 438 | curl -H "Authorization: Bearer <server-auth-token>" \ |
| 439 | -H "Notion-Token: ntn_****" \ |
| 440 | -H "Content-Type: application/json" \ |
| 441 | -d '{"jsonrpc": "2.0", "method": "initialize", "params": {}, "id": 1}' \ |
| 442 | http://localhost:3000/mcp |
| 443 | |
| 444 | |
| 445 | How the token is resolved for each connection, in order: |
| 446 | |
| 447 | The `Notion-Token` header (preferred — unambiguous, and works alongside the |
| 448 | server's own `Authorization` gateway auth). If present it must be a valid |
| 449 | Notion token, otherwise the request is rejected with `401`. |
| 450 | `Authorization: Bearer ntn_****` — only when the server's own bearer auth is |
| 451 | turned off (`--unsafe-disable-auth`), so the header is free to carry the |
| 452 | Notion token directly. |
| 453 | Otherwise the startup env token (`NOTION_TOKEN` / `OPENAPI_MCP_HEADERS`), if |
| 454 | set, so passthrough and a default integration can coexist on one deployment. |
| 455 | |
| 456 | Notes: |
| 457 | |
| 458 | Only values with a Notion token prefix (`ntn_`, legacy `secret_`) are treated |
| 459 | as Notion tokens, so the server's gateway secret and a tenant's Notion token |
| 460 | never collide. |
| 461 | Each token is bound to its MCP session; tokens are never logged (only a |
| 462 | redacted prefix is emitted). |
| 463 | This is a deliberate token-passthrough setup. Always deploy it over TLS, and |
| 464 | prefer keeping the server's own bearer auth (`--auth-token`) enabled as a |
| 465 | gateway in front of multi-tenant traffic. |
| 466 | |
| 467 | ### Examples |
| 468 | |
| 469 | Using the following instruction |
| 470 | |
| 471 | |
| 472 | Comment "Hello MCP" on page "Getting started" |
| 473 | |
| 474 | |
| 475 | AI will correctly plan two API calls, `v1/search` and `v1/comments`, to achieve the task |
| 476 | |
| 477 | Similarly, the following instruction will result in a new page named "Notion MCP" added to parent page "Development" |
| 478 | |
| 479 | |
| 480 | Add a page titled "Notion MCP" to page "Development" |
| 481 | |
| 482 | |
| 483 | You may also reference content ID directly |
| 484 | |
| 485 | |
| 486 | Get the content of page 1a6b35e6e67f802fa7e1d27686f017f2 |
| 487 | |
| 488 | |
| 489 | ### Development |
| 490 | |
| 491 | #### Build & test |
| 492 | |
| 493 | |
| 494 | npm run build |
| 495 | npm test |
| 496 | |
| 497 | |
| 498 | #### Execute |
| 499 | |
| 500 | |
| 501 | npx -y --prefix /path/to/local/notion-mcp-server @notionhq/notion-mcp-server |
| 502 | |
| 503 | |
| 504 | Testing changes locally in Cursor: |
| 505 | |
| 506 | Run `npm link` command from repository root to create a machine-global symlink to the `notion-mcp-server` package. |
| 507 | Merge the configuration snippet below into Cursor's `mcp.json` (or other MCP client you want to test with). |
| 508 | (Cleanup) run `npm unlink` from repository root. |
| 509 | |
| 510 | |
| 511 | { |
| 512 | "mcpServers": { |
| 513 | "notion-local-package": { |
| 514 | "command": "notion-mcp-server", |
| 515 | "env": { |
| 516 | "NOTION_TOKEN": "ntn_..." |
| 517 | } |
| 518 | } |
| 519 | } |
| 520 | } |
| 521 | |
| 522 | |
| 523 | #### Publish |
| 524 | |
| 525 | |
| 526 | npm login |
| 527 | npm publish --access public |
| 528 | |
| 529 |