diff --git a/Dockerfile b/Dockerfile index 07b0bae..5f0ec4f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,3 +1,4 @@ +# Generated by https://smithery.ai. See: https://smithery.ai/docs/build/project-config # Stage 1: Build the application FROM node:lts-alpine AS builder WORKDIR /app @@ -42,4 +43,4 @@ USER appuser # Command to run the server using the built output # This will start the MCP server listening on stdio -CMD ["node", "dist/index.js"] \ No newline at end of file +CMD ["node", "dist/index.js"] diff --git a/README.md b/README.md index 0c6e690..9e713e7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +@sylphxltd/pdf-reader-mcp +PDF Reader + [![MseeP.ai Security Assessment Badge](https://mseep.net/pr/sylphxltd-pdf-reader-mcp-badge.png)](https://mseep.ai/app/sylphxltd-pdf-reader-mcp) # PDF Reader MCP Server (@sylphlab/pdf-reader-mcp) @@ -9,6 +12,7 @@ [![npm version](https://badge.fury.io/js/%40sylphlab%2Fpdf-reader-mcp.svg)](https://badge.fury.io/js/%40sylphlab%2Fpdf-reader-mcp) [![Docker Pulls](https://img.shields.io/docker/pulls/sylphlab/pdf-reader-mcp.svg)](https://hub.docker.com/r/sylphlab/pdf-reader-mcp) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![smithery badge](https://smithery.ai/badge/@sylphxltd/pdf-reader-mcp)](https://smithery.ai/server/@sylphxltd/pdf-reader-mcp) @@ -92,6 +96,14 @@ Configure your MCP host to run the container, mounting your project directory to ``` _(Ensure the host sets the correct `cwd` for the target project)_ +### Installing via Smithery + +To install PDF Reader for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@sylphxltd/pdf-reader-mcp): + +```bash +npx -y @smithery/cli install @sylphxltd/pdf-reader-mcp --client claude +``` + ## Quick Start Assuming the server is running and configured in your MCP host: @@ -215,4 +227,5 @@ For detailed usage, API reference, and guides, please visit the **[Full Document ## License -This project is licensed under the [MIT License](./LICENSE). \ No newline at end of file +This project is licensed under the [MIT License](./LICENSE). + diff --git a/smithery.yaml b/smithery.yaml new file mode 100644 index 0000000..d870e55 --- /dev/null +++ b/smithery.yaml @@ -0,0 +1,14 @@ +# Smithery configuration file: https://smithery.ai/docs/build/project-config + +startCommand: + type: stdio + commandFunction: + # A JS function that produces the CLI command based on the given config to start the MCP on stdio. + |- + (config) => ({ command: 'node', args: ['dist/index.js'], env: {} }) + configSchema: + # JSON Schema defining the configuration options for the MCP. + type: object + properties: {} + description: No configuration necessary + exampleConfig: {}