PageIndex/README.md

109 lines
3 KiB
Markdown
Raw Normal View History

2025-04-30 20:51:59 +07:00
<div align="center">
2025-09-18 00:57:48 +01:00
<a href="https://pageindex.ai/mcp">
<img src="https://docs.pageindex.ai/images/general/mcp_banner.jpg">
</a>
2025-08-07 23:05:02 +01:00
</div>
2025-06-17 12:25:25 +01:00
2025-04-01 18:54:08 +08:00
2025-09-18 00:57:48 +01:00
# PageIndex MCP
2025-08-20 01:52:48 +08:00
2025-09-18 00:57:48 +01:00
Want to chat with PDF on Claude but got limit reached error? You can add your file to PageIndex to seamlessly chat with long PDFs on your Claude desktop.
2025-05-20 12:31:27 +01:00
2025-09-18 00:57:48 +01:00
- Support local and online PDFs
- Free 1000 pages
- Unlimited conversations
For more information about PageIndex MCP, check out the [PageIndex MCP](https://pageindex.ai/mcp) project page.
2025-08-24 17:30:21 +08:00
2025-09-18 00:57:48 +01:00
# What is PageIndex?
2025-08-24 17:30:21 +08:00
2025-08-25 17:50:53 +08:00
<div align="center">
2025-09-18 00:57:48 +01:00
<a href="https://pageindex.ai/mcp">
<img src="https://docs.pageindex.ai/images/cookbook/vectorless-rag.png" width="80%">
</a>
2025-08-25 17:50:53 +08:00
</div>
2025-08-24 17:30:21 +08:00
2025-09-18 00:57:48 +01:00
PageIndex is a vectorless **reasoning-based RAG** system which uses multi-step reasoning and tree search to retrieve information like a human expert would. It has the following properties:
2025-04-01 18:54:08 +08:00
2025-09-18 00:57:48 +01:00
- **Higher Accuracy**: Relevance beyond similarity -
- **Better Transparency**: Clear reasoning trajectory with traceable search paths
- **Like A Human**: Retrieve information like a human expert navigates documents
- **No Vector DB**: No extra infrastructure overhead
- **No Chunking**: Preserve full document context and structure
- **No Top-K**: Retrieve all relevant passages automatically
2025-04-01 18:54:08 +08:00
2025-05-06 05:21:08 +08:00
2025-08-25 17:50:53 +08:00
---
2025-09-18 00:57:48 +01:00
# PageIndex MCP Setup
See [PageIndex MCP](https://pageindex.ai/mcp) for full video guidances.
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
### 1. For Claude Desktop (Recommended)
2025-04-01 18:54:08 +08:00
2025-09-18 00:57:48 +01:00
**One-Click Installation with Desktop Extension (DXT):**
2025-04-01 18:54:08 +08:00
2025-09-18 00:57:48 +01:00
1. Download the latest `.dxt` file from [Releases](https://github.com/VectifyAI/pageindex-mcp/releases)
2. Double-click the `.dxt` file to install automatically in Claude Desktop
3. The OAuth authentication will be handled automatically when you first use the extension
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
This is the easiest way to get started with PageIndex's reasoning-based RAG capabilities.
2025-08-25 17:50:53 +08:00
2025-09-18 00:57:48 +01:00
### 2. For Other MCP-Compatible Clients
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
#### Option 1: Local MCP Server (with local PDF upload)
2025-04-01 18:54:08 +08:00
2025-09-18 00:57:48 +01:00
**Requirements:** Node.js ≥18.0.0
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
Add to your MCP configuration:
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
```json
{
"mcpServers": {
"pageindex": {
"command": "npx",
"args": ["-y", "pageindex-mcp"]
}
}
}
2025-04-01 18:54:08 +08:00
```
2025-04-10 11:38:54 +08:00
2025-09-18 00:57:48 +01:00
> **Note**: This local server provides full PDF upload capabilities and handles all authentication automatically.
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
#### Option 2: Direct Connection to PageIndex
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
Connect directly to the PageIndex OAuth-enabled MCP server:
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
```json
{
"mcpServers": {
"pageindex": {
"type": "http",
"url": "https://mcp.pageindex.ai/mcp"
}
}
}
2025-04-12 01:27:24 +08:00
```
2025-08-25 17:50:53 +08:00
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
**For clients that don't support HTTP MCP servers:**
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
If your MCP client doesn't support HTTP servers directly, you can use [mcp-remote](https://github.com/geelen/mcp-remote) as a bridge:
2025-09-02 10:18:28 +01:00
2025-09-18 00:57:48 +01:00
```json
{
"mcpServers": {
"pageindex": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.pageindex.ai/mcp"]
}
}
}
2025-09-02 10:18:28 +01:00
```
2025-09-18 00:57:48 +01:00
> **Note**: Option 1 provides local PDF upload capabilities, while Option 2 only supports PDF processing via URLs (no local file uploads).
2025-08-20 01:23:03 +08:00
2025-04-12 01:27:24 +08:00
2025-09-18 00:57:48 +01:00
## License
2025-09-03 18:56:29 +08:00
2025-09-18 00:57:48 +01:00
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.