Files
JoyD/pdf-reader-mcp/docs/guide/getting-started.md
2025-10-22 16:24:07 +08:00

3.7 KiB

Getting Started

This guide assumes you have an MCP client or host environment capable of launching and communicating with the PDF Reader MCP Server.

1. Launch the Server

Ensure the server is launched with its working directory set to the root of the project containing the PDF files you want to access.

  • If installed via npm/pnpm: Your MCP host might manage this automatically via npx @sylphlab/pdf-reader-mcp.
  • If running standalone: cd /path/to/your/project && node /path/to/pdf-reader-mcp/build/index.js
  • If using Docker: docker run -i --rm -v \"/path/to/your/project:/app\" sylphlab/pdf-reader-mcp:latest

2. Using the read_pdf Tool

The server provides a single primary tool: read_pdf.

Tool Input Schema:

The read_pdf tool accepts an object with the following properties:

  • sources (Array