@agent2pdf/mcp-server 1.0.0

package/README.md

@@ -0,0 +1,209 @@
+# @agent2pdf/mcp-server
+
+Official MCP (Model Context Protocol) Server for Agent2PDF with auto-polling support.
+
+This MCP Server acts as a bridge between MCP clients (like Claude Desktop, Cursor) and the Agent2PDF async job API. It automatically handles job creation, polling, and returns a direct download URL when the PDF is ready, providing a "pseudo-synchronous" experience.
+
+## Features
+
+- 🚀 **Auto-polling**: Automatically polls job status until completion
+- 📦 **Zero-config**: Works out of the box with `npx`
+- 🔄 **Three tools**: `generate_pdf`, `list_available_templates`, `get_job_status`
+- ⚡ **Fast**: Typical wait time: 5-30 seconds
+
+## Installation
+
+### Using npx (Recommended)
+
+No installation needed! Use directly with `npx`:
+
+```bash
+npx @agent2pdf/mcp-server
+```
+
+### Local Installation
+
+```bash
+npm install -g @agent2pdf/mcp-server
+```
+
+## Configuration
+
+### Claude Desktop
+
+Add to your Claude Desktop config file (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
+
+```json
+{
+  "mcpServers": {
+    "agent2pdf": {
+      "command": "npx",
+      "args": ["@agent2pdf/mcp-server"],
+      "env": {
+        "AGENT2PDF_API_KEY": "your-api-key-here"
+      }
+    }
+  }
+}
+```
+
+Or if installed globally:
+
+```json
+{
+  "mcpServers": {
+    "agent2pdf": {
+      "command": "agent2pdf-mcp",
+      "env": {
+        "AGENT2PDF_API_KEY": "your-api-key-here"
+      }
+    }
+  }
+}
+```
+
+### Cursor
+
+Add to your Cursor settings (`.cursor/mcp.json` or similar):
+
+```json
+{
+  "mcpServers": {
+    "agent2pdf": {
+      "command": "npx",
+      "args": ["@agent2pdf/mcp-server"],
+      "env": {
+        "AGENT2PDF_API_KEY": "your-api-key-here"
+      }
+    }
+  }
+}
+```
+
+## Getting Your API Key
+
+1. Sign in to [Agent2PDF Dashboard](https://agent2pdf.com)
+2. Go to **Settings → API Keys**
+3. Create a new API key
+4. Copy the key and add it to your MCP configuration
+
+## Available Tools
+
+### `generate_pdf`
+
+Generate a PDF from Markdown content. This tool automatically handles the async job process and returns a download URL when ready.
+
+**Arguments:**
+- `markdown` (required): The document body in Markdown format
+- `template_type` (optional): Template type (`general`, `tech_spec`, `invoice`, `report`, `resume`, `letter`, `meeting`). Defaults to `general`
+- `title` (optional): Document title. Defaults to "Untitled"
+- `author` (optional): Author or company name
+- `template_id` (optional): Custom template ID if using a saved template
+
+**Example:**
+```
+Generate a PDF with markdown "# Hello\n\nWorld", title "Test Document", template_type "general"
+```
+
+### `list_available_templates`
+
+Get a list of available built-in PDF templates with descriptions and recommended use cases.
+
+**Arguments:** None
+
+**Example:**
+```
+List available templates
+```
+
+### `get_job_status`
+
+Check the status of an async PDF job. Useful for manual polling.
+
+**Arguments:**
+- `job_id` (required): The job ID returned by `generate_pdf` or `POST /api/v1/jobs`
+
+**Example:**
+```
+Check job status for job_id "abc123"
+```
+
+## How It Works
+
+1. **Job Creation**: When `generate_pdf` is called, the server creates an async job via `POST /api/v1/jobs`
+2. **Auto-polling**: The server polls `GET /api/v1/jobs/{job_id}` every 3 seconds
+3. **Completion**: When the job status is `completed`, it returns the download URL
+4. **Error Handling**: If the job fails or times out, it returns an error message
+
+## Development
+
+### Prerequisites
+
+- Node.js >= 18
+- pnpm (recommended) or npm
+
+### Setup
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build
+pnpm build
+
+# Development mode (watch)
+pnpm dev
+```
+
+### Local Testing
+
+#### 自動化測試腳本
+
+使用內建的測試腳本快速驗證所有功能：
+
+```bash
+# 設定 API Key
+export AGENT2PDF_API_KEY="your-api-key"
+
+# 執行測試
+npm test
+
+# 或直接執行
+node test-mcp-server.js
+```
+
+測試腳本會自動測試：
+- ✅ 環境變數檢查
+- ✅ 列出可用模板
+- ✅ 建立 PDF Job
+- ✅ 輪詢 Job 狀態直到完成
+- ✅ MCP Server 基本連線
+
+#### 手動測試
+
+```bash
+# Link globally for testing
+pnpm link --global
+
+# Then use in Claude Desktop config
+{
+  "mcpServers": {
+    "agent2pdf": {
+      "command": "agent2pdf-mcp",
+      "env": {
+        "AGENT2PDF_API_KEY": "your-test-key"
+      }
+    }
+  }
+}
+```
+
+## License
+
+MIT
+
+## Support
+
+- Documentation: [https://agent2pdf.com/docs](https://agent2pdf.com/docs)
+- API Reference: [https://agent2pdf.com/docs/api](https://agent2pdf.com/docs/api)
+- Issues: [GitHub Issues](https://github.com/AustinChou/agent2pdf/issues)

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }