Notionmcp

🚀 Notion MCP Server

This is a Model Context Protocol (MCP) server that connects Claude and other AI assistants to your Notion workspace. This integration allows AI assistants to view, search, and manipulate your Notion databases, pages, and block content.

🚀 Quick Start

What is it?

This tool acts as a bridge between AI assistants (such as Claude) and your Notion workspace. It enables AI to:

• View and search your Notion databases
• Create and update pages
• Manage content blocks
• And many more!

📦 Installation

Prerequisites

• Node.js (version 14 or higher)
• A Notion account
• The Claude desktop application (if you plan to use it with Claude)

Step 1: Obtain a Notion API Key

1. Log in to Notion.
2. Go to "Settings" > "Security" > "Generate API Key".
3. Copy the generated API key.

Step 2: Install Node.js

1. Download and install Node.js (including npm).
   • Visit the Node.js official page to download the version suitable for your operating system.
2. After installation, open the terminal or command prompt and enter the following commands to verify:

   node -v
   npm -v
   

   If the version numbers are displayed, the installation is successful.

Step 3: Clone the Notion MCP Server Repository

1. Open the terminal or command prompt.
2. Run the following command to clone the repository to your local machine:

   git clone https://github.com/notion-mcp-server/notion-mcp.git
   

3. Switch to the cloned directory:

   cd notion-mcp
   

Step 4: Install Dependencies

1. Run the following command to install the project's required dependencies:

   npm install
   

Step 5: Configure the Server

1. Create a .env file in the project root directory.
2. Add the following content to the .env file, replacing the placeholder with your actual value:

   NOTION_API_KEY=your_notion_api_key_here
   

3. Save and close the file.

Step 6: Start the Server

1. Run the following command in the terminal or command prompt to start the server:

   npm start
   

2. If everything goes well, you will see output similar to the following in the console:

   Server is running on port 3000
   

💻 Usage Examples

Available Tools

The server provides the following tools for AI assistants:

• list-databases: List all accessible databases
• query-database: Retrieve entries from a database
• create-page: Add a new page to a database
• update-page: Modify an existing page
• create-database: Create a new database
• update-database: Modify the database structure
• get-page: View a specific page
• get-block-children: Get the content blocks of a page
• append-block-children: Add content to a page
• update-block: Edit a content block
• get-block: View a specific block
• search: Search for content across the entire workspace

🔧 Troubleshooting

Common Issues:

1. "Connection failed" appears in Claude:

   • Check if the server path in the claude_desktop_config.json file is correct.
   • Ensure that your Notion API key is valid.
   • Confirm that Node.js is installed.

2. "Access denied" when accessing Notion content:

   • Make sure you have shared the page/database with your integration.
   • Check if the API key has the necessary permissions.

3. The server fails to start:

   • Ensure that all dependencies are installed (npm install).
   • Check if the .env file exists and contains a valid API key.

🆘 Getting Help

If you encounter issues not listed here, please:

• Check the error messages in the console output.
• Ensure that your Notion API key is valid.
• Verify that your integration has permission to access the pages/databases.

📄 License

MIT