@doccler/mcp-server 1.0.0 → 1.0.2

package/README.md

@@ -2,118 +2,108 @@
 
 🚀 **Connect your IDE to Doccler** - Use AI-powered documentation directly from your development environment.
 
+[![npm version](https://badge.fury.io/js/@doccler%2Fmcp-server.svg)](https://www.npmjs.com/package/@doccler/mcp-server)
+
 ## What is MCP?
 
 The Model Context Protocol (MCP) is an open standard that allows AI assistants (like Claude, Cursor, VS Code with AI extensions) to connect to external tools and data sources. Doccler's MCP server enables you to:
 
-1. **Query your documentation** as a single source of truth
-2. **Create documentation** directly from your IDE
-3. **Search documentation** with semantic search
-4. **Generate documentation** from code using AI
-
-## Installation
-
-### Prerequisites
-
-- Node.js 18 or higher
-- npm or yarn
-- A Doccler account with API access
-
-### Install Dependencies
-
-```bash
-cd mcp-server
-npm install
-```
-
-### Build the Server
+- **Query your documentation** as a single source of truth
+- **Create documentation** directly from your IDE
+- **Search documentation** with semantic search
+- **Generate documentation** from code using AI
+- **Publish/unpublish** documents
+- **Organize** documents into spaces
 
-```bash
-npm run build
-```
-
-## Configuration
+## Quick Start
 
 ### 1. Get Your Doccler API Key
 
 1. Log in to [Doccler](https://doccler.com)
 2. Go to **Settings** → **API Keys**
-3. Generate a new API key
+3. Click **Create New API Key**
+4. Copy the key (it's only shown once!)
 
 ### 2. Configure Your IDE
 
-#### For Antigravity (VS Code based)
+Choose your IDE and add the configuration:
 
-Add to your `~/.antigravity/settings.json`:
+#### Cursor (`~/.cursor/mcp.json`)
 
 ```json
 {
-  "mcp": {
-    "servers": {
-      "doccler": {
-        "command": "node",
-        "args": ["/path/to/docs-platform/mcp-server/dist/index.js"],
-        "env": {
-          "DOCCLER_API_KEY": "your-api-key-here",
-          "DOCCLER_API_URL": "https://doccler.com/api"
-        }
+  "mcpServers": {
+    "doccler": {
+      "command": "npx",
+      "args": ["-y", "@doccler/mcp-server@latest"],
+      "env": {
+        "DOCCLER_API_KEY": "doccler_xxxxxxxx_yyyyyyyyyyyyyyyyyyyy"
       }
     }
   }
 }
 ```
 
-#### For Cursor
+#### Claude Desktop
 
-Add to your `~/.cursor/mcp.json`:
+**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
+**Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
 
 ```json
 {
   "mcpServers": {
     "doccler": {
-      "command": "node",
-      "args": ["/path/to/docs-platform/mcp-server/dist/index.js"],
+      "command": "npx",
+      "args": ["-y", "@doccler/mcp-server@latest"],
       "env": {
-        "DOCCLER_API_KEY": "your-api-key-here",
-        "DOCCLER_API_URL": "https://doccler.com/api"
+        "DOCCLER_API_KEY": "doccler_xxxxxxxx_yyyyyyyyyyyyyyyyyyyy"
       }
     }
   }
 }
 ```
 
-#### For Claude Desktop
+#### VS Code / Antigravity
 
-Add to your `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
+Add to your MCP settings:
 
 ```json
 {
-  "mcpServers": {
-    "doccler": {
-      "command": "node",
-      "args": ["/path/to/docs-platform/mcp-server/dist/index.js"],
-      "env": {
-        "DOCCLER_API_KEY": "your-api-key-here",
-        "DOCCLER_API_URL": "https://doccler.com/api"
+  "mcp": {
+    "servers": {
+      "doccler": {
+        "command": "npx",
+        "args": ["-y", "@doccler/mcp-server@latest"],
+        "env": {
+          "DOCCLER_API_KEY": "doccler_xxxxxxxx_yyyyyyyyyyyyyyyyyyyy"
+        }
       }
     }
   }
 }
 ```
 
-#### For TRAE
+### 3. Restart Your IDE
+
+After adding the configuration, restart your IDE. The Doccler MCP server will be downloaded and started automatically.
+
+## Alternative: Global Installation
+
+If you prefer to install globally instead of using `npx`:
+
+```bash
+npm install -g @doccler/mcp-server
+```
 
-Add to your TRAE MCP configuration:
+Then configure your IDE with:
 
 ```json
 {
-  "servers": {
+  "mcpServers": {
     "doccler": {
-      "command": "node",
-      "args": ["/path/to/docs-platform/mcp-server/dist/index.js"],
+      "command": "doccler-mcp",
       "env": {
-        "DOCCLER_API_KEY": "your-api-key-here",
-        "DOCCLER_API_URL": "https://doccler.com/api"  
+        "DOCCLER_API_KEY": "doccler_xxxxxxxx_yyyyyyyyyyyyyyyyyyyy"
       }
     }
   }
@@ -122,62 +112,50 @@ Add to your TRAE MCP configuration:
 
 ## Available Tools
 
-### 🔧 hello_doccler
+| Tool | Description |
+|------|-------------|
+| `hello_doccler` | Verify your connection to Doccler |
+| `search_docs` | Search your documentation (keyword + semantic) |
+| `create_doc` | Create new documentation with optional space |
+| `generate_doc` | Generate documentation from code using AI |
+| `publish_doc` | Publish or unpublish a document |
+| `get_doc` | Get the content of a specific document |
+| `list_spaces` | List all available spaces |
 
-Verify your connection to Doccler.
+## Usage Examples
 
+### Search Documentation
 ```
-Use: "Hello Doccler" or "Test Doccler connection"
+"Search my documentation for authentication"
+"Find docs about API endpoints"
 ```
 
-### 🔍 search_docs
-
-Search your documentation.
-
+### Create Documentation
 ```
-Use: "Search my documentation for authentication"
-     "Find docs about JWT tokens"
+"Create documentation titled 'Getting Started' about how to install the app"
+"Create a doc in the API space explaining the user endpoint"
 ```
 
-### 📝 create_doc
-
-Create new documentation.
-
+### Generate from Code
 ```
-Use: "Create documentation titled 'API Guide' with content..."
+"Generate documentation for this code: [paste your code]"
+"Document this function with examples"
 ```
 
-### 🤖 generate_doc
-
-Generate documentation from code using AI.
-
+### Publish/Unpublish
 ```
-Use: "Generate documentation for this code: [paste your code]"
-     "Analyze and document this function"
+"Publish the document with slug 'getting-started'"
+"Unpublish my-api-guide"
 ```
 
-## Development
-
-### Run in Development Mode
-
-```bash
-npm run dev
-```
-
-### Test with MCP Inspector
-
-```bash
-npm run inspect
-```
-
-This opens an interactive inspector to test your tools and resources.
-
 ## Environment Variables
 
 | Variable | Description | Default |
 |----------|-------------|---------|
-| `DOCCLER_API_KEY` | Your Doccler API key | (required) |
-| `DOCCLER_API_URL` | Doccler API base URL | `https://doccler.com/api` |
+| `DOCCLER_API_KEY` | Your Doccler API key | **(required)** |
+| `DOCCLER_API_URL` | API URL (for self-hosted) | `https://doccler.com/api` |
+
+> **Note:** `DOCCLER_API_URL` is only needed for self-hosted instances or development. Production users can omit it.
 
 ## Troubleshooting
 
@@ -185,16 +163,24 @@ This opens an interactive inspector to test your tools and resources.
 
 Make sure `DOCCLER_API_KEY` is set in your IDE's MCP configuration.
 
-### "Connection failed"
+### "Unauthorized" errors
+
+1. Check that your API key is valid
+2. Go to Settings → API Keys in Doccler to verify
+3. Create a new key if needed
+
+### Server not starting
 
-1. Check that the server is built: `npm run build`
-2. Verify the path to `dist/index.js` is correct
-3. Ensure Node.js 18+ is installed
+1. Ensure Node.js 18+ is installed
+2. Try running manually: `npx @doccler/mcp-server`
+3. Check your IDE's MCP logs
 
-### Server logs
+## Support
 
-Look for logs in your IDE's output panel, usually under "MCP" or "Extensions".
+- **Documentation:** [doccler.com/docs](https://doccler.com/docs)
+- **Issues:** [GitHub Issues](https://github.com/doccler/mcp-server/issues)
+- **Email:** hello@doccler.com
 
 ## License
 
-MIT
+MIT © Doccler

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doccler/mcp-server",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "Doccler MCP Server - Connect your IDE to your documentation platform",
     "type": "module",
     "main": "dist/index.js",
@@ -54,4 +54,4 @@
     "publishConfig": {
         "access": "public"
     }
-}
+}