GITHUB_SETUP.md•5.51 kB
# GitHub Repository Setup Guide
Follow these steps to push your Cursor Notion MCP repository to GitHub.
## Step 1: Create a New GitHub Repository
1. Go to [https://github.com/new](https://github.com/new)
2. Fill in the details:
- **Repository name**: `cursor-notion-mcp`
- **Description**: "MCP server for logging Cursor AI chat interactions to Notion"
- **Visibility**: Public (so others can use it)
- **Initialize**: ❌ Do NOT initialize with README, .gitignore, or license (we already have these)
3. Click **"Create repository"**
## Step 2: Push to GitHub
GitHub will show you commands. Use these:
```bash
cd /Users/dhairya.bhuta/Documents/Creopsan/cursor-notion-mcp
# Add the remote repository
git remote add origin https://github.com/YOUR_USERNAME/cursor-notion-mcp.git
# Push to GitHub
git branch -M main
git push -u origin main
```
**Replace `YOUR_USERNAME`** with your actual GitHub username!
## Step 3: Verify on GitHub
1. Go to `https://github.com/YOUR_USERNAME/cursor-notion-mcp`
2. You should see:
- ✅ README.md displayed on the homepage
- ✅ All files (mcp_notion_server.py, test scripts, etc.)
- ✅ LICENSE file
- ✅ .gitignore
## Step 4: Update README with Your GitHub Username
Edit `README.md` and replace all instances of `YOUR_USERNAME` with your actual GitHub username:
```bash
# Find and replace
sed -i '' 's/YOUR_USERNAME/your-actual-username/g' README.md
# Commit the change
git add README.md
git commit -m "Update GitHub username in README"
git push
```
## Step 5: Add Topics (Optional but Recommended)
On your GitHub repository page:
1. Click the ⚙️ gear icon next to "About"
2. Add topics:
- `cursor`
- `mcp`
- `notion`
- `chat-logger`
- `model-context-protocol`
- `cursor-ide`
- `notion-api`
3. Click "Save changes"
## Step 6: Share Your Repository
Now others can use your MCP server by:
```bash
git clone https://github.com/YOUR_USERNAME/cursor-notion-mcp.git
cd cursor-notion-mcp
pip3 install -r requirements.txt
# Follow SETUP.md
```
## Important: Sharing with Others
### What They Need to Do
1. **Get their own Notion API key**:
- They need to create their own Notion integration
- They'll get their own `secret_...` token
2. **Create their own Notion database**:
- They need to create a database in their Notion workspace
- Add the required properties (Prompt, Response, User, Context, Timestamp)
- Share it with their integration
3. **Configure their own `~/.cursor/mcp.json`**:
- They'll use their own API key and database ID
- They'll point to their local copy of `mcp_notion_server.py`
### What Gets Shared
✅ **Shared** (in the repository):
- The MCP server code (`mcp_notion_server.py`)
- Test scripts
- Documentation
- Setup instructions
❌ **NOT Shared** (private to each user):
- Notion API keys
- Database IDs
- Chat logs (stored in their own Notion workspace)
### Security Note
⚠️ **Your Notion API key is NOT in the repository!**
The repository only contains the code. Each user must:
1. Create their own Notion integration
2. Get their own API key
3. Configure it in their local `~/.cursor/mcp.json` (which is NOT in the repo)
This is secure by design! 🔒
## Example: How Someone Else Would Use It
```bash
# 1. Clone your repository
git clone https://github.com/dhairyabhuta/cursor-notion-mcp.git
cd cursor-notion-mcp
# 2. Install dependencies
pip3 install -r requirements.txt
# 3. Create their own Notion integration and database
# (following SETUP.md)
# 4. Configure their ~/.cursor/mcp.json with THEIR credentials
{
"mcpServers": {
"notion-chat-logger": {
"command": "python3",
"args": ["/Users/theirname/cursor-notion-mcp/mcp_notion_server.py"],
"env": {
"NOTION_API_KEY": "secret_THEIR_TOKEN",
"NOTION_DATABASE_ID": "THEIR_DATABASE_ID"
}
}
}
}
# 5. Restart Cursor and use it!
```
## Updating the Repository
When you make changes:
```bash
cd /Users/dhairya.bhuta/Documents/Creopsan/cursor-notion-mcp
# Make your changes...
# Stage and commit
git add -A
git commit -m "Description of changes"
# Push to GitHub
git push
```
## Adding a Nice README Badge
Add this to the top of your README.md:
```markdown
[](https://github.com/YOUR_USERNAME/cursor-notion-mcp)
[](https://github.com/YOUR_USERNAME/cursor-notion-mcp/fork)
```
## Recommended: Add a Screenshot
Take a screenshot of:
1. The tool working in Cursor (showing the `@store_chat_log` picker)
2. The resulting entry in Notion
Add them to the repository:
```bash
# Add screenshots
mkdir screenshots
# Copy your screenshots to this folder
git add screenshots/
git commit -m "Add screenshots"
git push
```
Then reference them in README.md:
```markdown
## Screenshots
### Using in Cursor
### Result in Notion
```
## Next Steps
- ✅ Create the GitHub repository
- ✅ Push your code
- ✅ Update the README with your username
- ✅ Add topics/tags
- ✅ Share the link with others!
- 📸 (Optional) Add screenshots
- ⭐ (Optional) Ask people to star your repo
---
**Your repository URL will be:**
`https://github.com/YOUR_USERNAME/cursor-notion-mcp`
Share this with anyone who wants to use the MCP server! 🎉