engram-notion-mcp 0.1.1 → 1.0.0-rc.0

package/README.md

@@ -47,32 +47,39 @@ To use Engram Notion MCP, you need to set up your environment variables.
 | `TELEGRAM_CHAT_ID` | No | For `send_alert` tool. |
 | `AGENT_MEMORY_PATH` | No | Custom path for the SQLite memory database. |
 
-### 💡 Quick Setup Tips
-
-<details>
-<summary><strong>🔑 How to get Notion API Key</strong></summary>
-
-1.  Go to [Notion My Integrations](https://www.notion.so/my-integrations).
-2.  Click **New integration**.
-3.  Name it (e.g., "Engram Notion MCP") and submit.
-4.  Copy the **Internal Integration Secret**. this is your `NOTION_API_KEY`.
-</details>
+---
 
-<details>
-<summary><strong>🤖 How to get Telegram Bot Token & Chat ID</strong></summary>
-
-1.  **Bot Token**:
-    - Open Telegram and search for **@BotFather**.
-    - Send the command `/newbot`.
-    - Follow the prompts to name your bot.
-    - Copy the **HTTP API Token**.
-
-2.  **Chat ID**:
-    - Search for **@userinfobot** in Telegram.
-    - Click Start or send `/start`.
-    - It will reply with your **Id**. Copy this number.
-</details>
+> ### 💡 Quick Setup Tips
+> <details>
+> <summary>
+> <strong>🔑 How to get Notion API Key</strong>
+> </summary>
+>
+> 1.  Go to [Notion My Integrations](https://www.notion.so/my-integrations).
+> 2.  Click **New integration**.
+> 3.  Name it (e.g., "Engram Notion MCP") and submit.
+> 4.  Copy the **Internal Integration Secret**. this is your `NOTION_API_KEY`.
+> </details>
+>
+> <details>
+> <summary>
+> <strong>🤖 How to get Telegram Bot Token & Chat ID</strong>
+> </summary>
+>
+> 1.  **Bot Token**:
+>     - Open Telegram and search for **@BotFather**.
+>     - Send the command `/newbot`.
+>     - Follow the prompts to name your bot.
+>     - Copy the **HTTP API Token**.
+>
+> 2.  **Chat ID**:
+>     - Search for **@userinfobot** in Telegram.
+>     - Click Start or send `/start`.
+>     - It will reply with your **Id**. Copy this number.
+> </details>
+>
 
+---
 
 ### Configuration Patterns
 
@@ -96,21 +103,24 @@ To give the agent access to multiple specific pages:
 
 ---
 
-## 🔌 Client Setup Instructions
-Configure your favorite AI tool to use Engram Notion MCP. Click to expand your tool of choice:
+## 🔌 Installation & Client Setup Instructions
 
-<details>
-<summary><strong>🖥️ Desktop Apps (Claude Desktop, ChatGPT)</strong></summary>
+<details open>
+<summary>
+<h3 style="display: inline-block;"> ⚡ Recommended (Fastest) - Bun</h3>
+</summary>
+
+Use `bunx` to run the server with native performance (`bun:sqlite`).
 
 Add this to your `claude_desktop_config.json` or `mcp.json`.
 
-**Config for using `npx` (Recommended):**
+**Config using `bunx` (Recommended):**
 ```json
 {
   "mcpServers": {
-    "engram": {
-      "command": "npx",
-      "args": ["-y", "engram-mcp"],
+    "engram-notion-mcp": {
+      "command": "bunx",
+      "args": ["engram-notion-mcp"],
       "env": {
         "NOTION_API_KEY": "secret_your_key_here"
       }
@@ -120,67 +130,116 @@ Add this to your `claude_desktop_config.json` or `mcp.json`.
 ```
 </details>
 
+---
+
 <details>
-<summary><strong>🆚 VS Code & Extensions (Cursor, Windsurf, Cline, Roo Code)</strong></summary>
+<summary>
+<h3 style="display: inline-block;"> 🐢 Standard - Node.js (NPX)</h3>
+</summary>
+
+Works with any standard Node.js environment (`better-sqlite3`).
 
-Most VS Code environments use a `mcpServers` object in their settings.
+Add this to your `claude_desktop_config.json` or `mcp.json`.
 
-**Generic Config:**
+**Config using `npx` (Standard):**
 ```json
-"mcpServers": {
-  "engram": {
-    "command": "npx",
-    "args": ["-y", "engram-mcp"],
-    "env": {
-      "NOTION_API_KEY": "secret_your_key_here"
+{
+  "mcpServers": {
+    "engram-notion-mcp": {
+      "command": "npx",
+      "args": ["-y", "engram-notion-mcp"],
+      "env": {
+        "NOTION_API_KEY": "secret_your_key_here"
+      }
     }
   }
 }
 ```
-
-**Where to put it:**
-- **Cursor / Windsurf / VS Code**: User Settings (`settings.json`).
-- **Cline / Roo Code**: Extension Settings -> MCP Servers.
-- **Kilo Code**: `.kilo/config.json`.
 </details>
 
+---
+
 <details>
-<summary><strong>⌨️ CLI Tools (Gemini CLI, Claude Code)</strong></summary>
+<summary>
+<h3 style="display: inline-block;"> 🐍 Alternative - Python (UVX / PIPX)</h3>
+</summary>
 
-**Gemini CLI:**
-```bash
-gemini mcp add engram node "npx engram-mcp" -e NOTION_API_KEY=secret_...
-```
+If you prefer `uvx` or `pipx` or have strict Python environments:
 
-**Claude Code:**
-```bash
-export NOTION_API_KEY=secret_...
-claude --mcp engram-mcp
+Add this to your `claude_desktop_config.json` or `mcp.json`.
+
+**Config using `uvx` (Alternative):**
+```json
+{
+  "mcpServers": {
+    "engram-notion-mcp": {
+      "command": "uvx",
+      "args": ["engram-notion-mcp"],
+      "env": {
+        "NOTION_API_KEY": "secret_your_key_here"
+      }
+    }
+  }
+}
 ```
-</details>
 
-<details>
-<summary><strong>🐍 Manual / Python Native</strong></summary>
+---
 
-If you prefer `uvx` or have strict Python environments:
+**Config using `pipx` (Alternative):**
 
 ```json
-"engram": {
-  "command": "uvx",
-  "args": ["engram-mcp"],
-  "env": { ... }
+{
+  "mcpServers": {
+    "engram-notion-mcp": {
+      "command": "pipx",
+      "args": ["run", "engram-notion-mcp"],
+      "env": { ... }
+    }
+  }
 }
 ```
 </details>
 
 ---
 
-## 🤝 Contributing
-1. Fork the repo.
-2. Create your feature branch (`git checkout -b feature/amazing-feature`).
-3. Commit your changes (`git commit -m 'Add amazing feature'`).
-4. Push to the branch (`git push origin feature/amazing-feature`).
-5. Open a Pull Request.
+**Where to put it:**
+- **🖥️ Desktop Apps (Claude Desktop): `claude_desktop_config.json`**
+- **🆚 VS Code / Cursor / Windsurf**: User Settings (`settings.json`).
+- **Cline / Roo Code**: Extension Settings -> MCP Servers.
+- **Kilo Code**: `.kilo/config.json`.
+- **⌨️ Gemini CLI:**
+    <details>
+    <summary>
+    <strong>Bun (Recommended)</strong>
+    </summary>
+
+    ```bash
+    gemini mcp add engram-notion-mcp bunx "engram-notion-mcp" -e NOTION_API_KEY=<your_secret_key>
+    ```
+    </details>
+
+    <details>
+    <summary>
+    <strong>Node.js - NPX (Standard)</strong>
+    </summary>
+
+    ```bash
+    gemini mcp add engram node "npx engram-notion-mcp" -e NOTION_API_KEY=<your_secret_key>
+    ```
+    </details>
 
 ---
-Built with ❤️ using [FastMCP](https://github.com/jlowin/fastmcp).
+
+## 💬 Support & Feedback
+If you face any issues or have suggestions, please feel free to:
+- Open an issue on this [GitHub Repository](https://github.com/shubhamomar/engram-notion-mcp/issues).
+- Reach out to me directly via my GitHub profile.
+
+---
+
+## Quick Links
+
+This MCP tool is published as a package on NPM and PyPI.
+
+- [Bun / Node.js Package on NPM](https://www.npmjs.com/package/engram-notion-mcp)
+- [Python Package on PyPI](https://pypi.org/project/engram-notion-mcp/)