Skip to content

Commit 0dc9577

Browse files
committed
docs: update README
1 parent 3f9c81d commit 0dc9577

File tree

1 file changed

+31
-11
lines changed

1 file changed

+31
-11
lines changed

README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ PageIndex is a revolutionary document processing system that uses **reasoning-ba
2222
- **Full PageIndex Integration**: Access all PageIndex capabilities (OCR, tree generation, reasoning-based retrieval)
2323
- **Secure Authentication**: API key authentication with PageIndex platform
2424
- **TypeScript**: Full type safety with MCP SDK
25-
- **Claude Desktop Ready**: Easy integration with Claude Desktop
25+
- **Desktop Extension (DXT)**: One-click installation for Claude Desktop with secure configuration
2626

2727
## Usage
2828

@@ -34,7 +34,26 @@ First, you'll need to create an API key:
3434
2. Create a new API key for your application
3535
3. Copy the API key for use in the configuration below
3636

37-
### Option 1: Local MCP Server (with local PDF upload)
37+
### For Claude Desktop (Recommended)
38+
39+
**One-Click Installation with Desktop Extension (DXT):**
40+
41+
1. Download the latest `.dxt` file from [Releases](https://github.com/VectifyAI/pageindex-mcp/releases)
42+
2. Double-click the `.dxt` file to install automatically in Claude Desktop
43+
3. Enter your PageIndex API key in the simple configuration interface
44+
45+
**Benefits of DXT Installation:**
46+
47+
- **No technical setup** - just download and double-click
48+
- **Secure configuration** - API keys stored securely by Claude Desktop
49+
- **Automatic updates** - extensions update seamlessly
50+
- **Full local PDF support** - upload and process PDFs directly from your computer
51+
52+
This is the easiest way to get started with PageIndex's reasoning-based RAG capabilities.
53+
54+
### For Other MCP-Compatible Clients
55+
56+
#### Option 1: Local MCP Server (with local PDF upload)
3857

3958
**Requirements:** Node.js ≥18.0.0
4059

@@ -54,7 +73,7 @@ Add to your MCP configuration:
5473
}
5574
```
5675

57-
### Option 2: Remote MCP Server
76+
#### Option 2: Remote MCP Server
5877

5978
Alternatively, connect directly to PageIndex without this wrapper:
6079

@@ -76,16 +95,17 @@ Alternatively, connect directly to PageIndex without this wrapper:
7695
7796
## Available Tools
7897

79-
| Tool | Description | Key Parameters |
80-
|------|-------------|----------------|
81-
| **process_document** | Upload and process PDF documents from local files or URLs with PageIndex OCR and tree generation | `url` - Local file path or PDF URL |
82-
| **recent_documents** | Get recent documents with status overview | `limit` (optional) |
83-
| **get_document** | Get basic document info and status | `doc_id` |
84-
| **get_document_structure** | Extract hierarchical document structure with configurable detail levels | `doc_id`, `max_depth` (1-10) |
85-
| **get_page_content** | Extract specific page content from processed documents | `doc_id`, `pages` ("5", "3-7", "1,5,10") |
86-
| **remove_document** | Permanently delete documents and associated data | `doc_ids` (array of document IDs) |
98+
| Tool | Description | Key Parameters |
99+
| -------------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------- |
100+
| **process_document** | Upload and process PDF documents from local files or URLs with PageIndex OCR and tree generation | `url` - Local file path or PDF URL |
101+
| **recent_documents** | Get recent documents with status overview | `limit` (optional) |
102+
| **get_document** | Get basic document info and status | `doc_id` |
103+
| **get_document_structure** | Extract hierarchical document structure with configurable detail levels | `doc_id`, `max_depth` (1-10) |
104+
| **get_page_content** | Extract specific page content from processed documents | `doc_id`, `pages` ("5", "3-7", "1,5,10") |
105+
| **remove_document** | Permanently delete documents and associated data | `doc_ids` (array of document IDs) |
87106

88107
> **Quick Example**: Process a local PDF with `process_document`, then extract content with `get_page_content` using the returned document ID.
89108
90109
## License
110+
91111
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.

0 commit comments

Comments
 (0)