{"_id":"@cyanheads/jinaai-mcp-server","_rev":"3-b55248305fecff1b9642812efdc1d1d5","name":"@cyanheads/jinaai-mcp-server","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.2":{"name":"@cyanheads/jinaai-mcp-server","version":"1.0.2","keywords":["typescript","mcp","model-context-protocol","agent","llm","ai-integration","mcp-server","jina","jina-ai","web-reader","content-extraction","scraping","llm-content-preparation","zod","opentelemetry","observability"],"author":{"url":"https://github.com/cyanheads/jinaai-mcp-server#readme","name":"cyanheads","email":"casey@caseyjhand.com"},"license":"Apache-2.0","_id":"@cyanheads/jinaai-mcp-server@1.0.2","maintainers":[{"name":"cyanheads","email":"casey@caseyjhand.com"}],"homepage":"https://github.com/cyanheads/jinaai-mcp-server#readme","bugs":{"url":"https://github.com/cyanheads/jinaai-mcp-server/issues"},"bin":{"jinaai-mcp-server":"dist/index.js"},"dist":{"shasum":"9f5867f620a71cd3c0e75a4620f2a95d1f167efa","tarball":"https://registry.npmjs.org/@cyanheads/jinaai-mcp-server/-/jinaai-mcp-server-1.0.2.tgz","fileCount":207,"integrity":"sha512-8rTVXmdUFnI/BTwHaqLB1Jx4tanUHw5OPPVc6tX42knqCTDRWaY1LLGF9KSe3l/Z2/qGyIARgeTVu3/hRV2P5g==","signatures":[{"sig":"MEUCIAgQEAXhVHioMqRjMKQBfL5wEkzlhC7v8097DnaCE2UJAiEAmwnkBFPTNF2p5Nsy5bqA52AY1J7bCZK9iE1eSgL4zys=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":512507},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","engines":{"node":">=20.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"funding":[{"url":"https://github.com/sponsors/cyanheads","type":"github"},{"url":"https://www.buymeacoffee.com/cyanheads","type":"buy_me_a_coffee"}],"gitHead":"b97ef5881e6f3e57c9412c5d6fb81cf601d7fb19","scripts":{"dev":"tsx --watch src/index.ts","lint":"eslint .","test":"vitest run","tree":"tsx scripts/tree.ts","audit":"npm audit --production","build":"tsc","start":"node dist/index.js","format":"prettier --write \"**/*.{ts,js,json,md,html,css}\"","rebuild":"tsx scripts/clean.ts && npm run build","depcheck":"npx depcheck","dev:http":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=http tsx --watch src/index.ts","lint:fix":"eslint . --fix","audit:fix":"npm audit fix --production","dev:agent":"MCP_LOG_LEVEL=debug tsx --watch src/agent/cli/boot.ts","dev:stdio":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=stdio tsx --watch src/index.ts","inspector":"npx mcp-inspector --config mcp.json --server mcp-ts-template","postbuild":"tsx scripts/make-executable.ts dist/index.js","typecheck":"tsc --noEmit","fetch-spec":"tsx scripts/fetch-openapi-spec.ts","start:http":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=http node dist/index.js","test:watch":"vitest","start:agent":"MCP_LOG_LEVEL=debug node dist/agent/cli/boot.js","start:stdio":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=stdio node dist/index.js","docs:generate":"typedoc --tsconfig ./tsconfig.typedoc.json","test:coverage":"vitest run --coverage","prepublishOnly":"npm run typecheck && npm run lint && npm run test && npm run build","db:duckdb-example":"MCP_LOG_LEVEL=debug tsc && node dist/storage/duckdbExample.js"},"_npmUser":{"name":"cyanheads","email":"casey@caseyjhand.com"},"repository":{"url":"git+https://github.com/cyanheads/jinaai-mcp-server.git","type":"git"},"_npmVersion":"10.8.2","description":"A Model Context Protocol (MCP) server that provides intelligent web reading capabilities using the Jina AI Reader API. It extracts clean, LLM-ready content from any URL.","directories":{},"_nodeVersion":"20.19.4","dependencies":{"zod":"^3.25.76","hono":"^4.8.9","jose":"^6.0.12","axios":"^1.11.0","dotenv":"^16.6.1","ignore":"^7.0.5","openai":"^5.11.0","js-yaml":"^4.1.0","winston":"^3.17.0","tiktoken":"^1.0.21","node-cron":"^4.2.1","validator":"13.15.15","chrono-node":"^2.8.0","partial-json":"^0.1.7","sanitize-html":"^2.17.0","@duckdb/node-api":"^1.3.2-alpha.25","reflect-metadata":"^0.2.2","@hono/node-server":"^1.17.1","winston-transport":"^4.9.0","@supabase/supabase-js":"^2.53.0","@modelcontextprotocol/sdk":"^1.17.1","@opentelemetry/instrumentation-winston":"^0.48.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"msw":"^2.10.4","tsx":"^4.20.3","eslint":"^9.32.0","vitest":"^3.2.4","globals":"^16.3.0","typedoc":"^0.28.9","depcheck":"^1.4.7","prettier":"^3.6.2","@eslint/js":"^9.32.0","typescript":"^5.8.3","@types/node":"^24.1.0","@types/js-yaml":"^4.0.9","@faker-js/faker":"^9.9.0","@types/node-cron":"^3.0.11","@types/validator":"13.15.2","@anatine/zod-mock":"^3.14.0","typescript-eslint":"^8.38.0","@opentelemetry/api":"^1.9.0","@vitest/coverage-v8":"^3.2.4","vite-tsconfig-paths":"^5.1.4","@types/sanitize-html":"^2.16.0","@opentelemetry/sdk-node":"^0.203.0","@opentelemetry/resources":"^2.0.1","@opentelemetry/sdk-metrics":"^2.0.1","@opentelemetry/sdk-trace-node":"^2.0.1","@opentelemetry/semantic-conventions":"^1.36.0","@opentelemetry/exporter-trace-otlp-http":"^0.203.0","@opentelemetry/auto-instrumentations-node":"^0.62.0","@opentelemetry/exporter-metrics-otlp-http":"^0.203.0"},"_npmOperationalInternal":{"tmp":"tmp/jinaai-mcp-server_1.0.2_1754223417118_0.12340503714894835","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@cyanheads/jinaai-mcp-server","version":"1.0.3","keywords":["typescript","mcp","model-context-protocol","agent","llm","ai-integration","mcp-server","jina","jina-ai","web-reader","content-extraction","scraping","llm-content-preparation","zod","opentelemetry","observability"],"author":{"url":"https://github.com/cyanheads/jinaai-mcp-server#readme","name":"cyanheads","email":"casey@caseyjhand.com"},"license":"Apache-2.0","_id":"@cyanheads/jinaai-mcp-server@1.0.3","maintainers":[{"name":"cyanheads","email":"casey@caseyjhand.com"}],"homepage":"https://github.com/cyanheads/jinaai-mcp-server#readme","bugs":{"url":"https://github.com/cyanheads/jinaai-mcp-server/issues"},"bin":{"jinaai-mcp-server":"dist/index.js"},"dist":{"shasum":"ba0b5ceed5918dc0f55b9db5192988e8cb32f622","tarball":"https://registry.npmjs.org/@cyanheads/jinaai-mcp-server/-/jinaai-mcp-server-1.0.3.tgz","fileCount":207,"integrity":"sha512-LsBngECEmvy64/Bm1aQ8EDeD7AhboAqX2rveVuDFbmjZschjS1vLlxlyESn+Q3GDw3+/fI+VSKKK+QVDs2Zd9w==","signatures":[{"sig":"MEYCIQD16L9QDfjb323nrdlVgyFuV9iQo9d2EVSfiVkZ1vEdkAIhANZH41ajXxxtqkUQhul8ayK5qK1tpyL86C8yXFxaUDGJ","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":512507},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","engines":{"node":">=20.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"funding":[{"url":"https://github.com/sponsors/cyanheads","type":"github"},{"url":"https://www.buymeacoffee.com/cyanheads","type":"buy_me_a_coffee"}],"gitHead":"a6c78a9912bda5c08556487532ac60af1656dc0b","scripts":{"dev":"tsx --watch src/index.ts","lint":"eslint .","test":"vitest run","tree":"tsx scripts/tree.ts","audit":"npm audit --production","build":"tsc","start":"node dist/index.js","format":"prettier --write \"**/*.{ts,js,json,md,html,css}\"","rebuild":"tsx scripts/clean.ts && npm run build","depcheck":"npx depcheck","dev:http":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=http tsx --watch src/index.ts","lint:fix":"eslint . --fix","audit:fix":"npm audit fix --production","dev:agent":"MCP_LOG_LEVEL=debug tsx --watch src/agent/cli/boot.ts","dev:stdio":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=stdio tsx --watch src/index.ts","inspector":"npx mcp-inspector --config mcp.json --server mcp-ts-template","postbuild":"tsx scripts/make-executable.ts dist/index.js","typecheck":"tsc --noEmit","fetch-spec":"tsx scripts/fetch-openapi-spec.ts","start:http":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=http node dist/index.js","test:watch":"vitest","start:agent":"MCP_LOG_LEVEL=debug node dist/agent/cli/boot.js","start:stdio":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=stdio node dist/index.js","docs:generate":"typedoc --tsconfig ./tsconfig.typedoc.json","test:coverage":"vitest run --coverage","prepublishOnly":"npm run typecheck && npm run lint && npm run test && npm run build","db:duckdb-example":"MCP_LOG_LEVEL=debug tsc && node dist/storage/duckdbExample.js"},"_npmUser":{"name":"cyanheads","email":"casey@caseyjhand.com"},"repository":{"url":"git+https://github.com/cyanheads/jinaai-mcp-server.git","type":"git"},"_npmVersion":"10.8.2","description":"A Model Context Protocol (MCP) server that provides intelligent web reading capabilities using the Jina AI Reader API. It extracts clean, LLM-ready content from any URL.","directories":{},"_nodeVersion":"20.19.4","dependencies":{"zod":"^3.25.76","hono":"^4.8.9","jose":"^6.0.12","axios":"^1.11.0","dotenv":"^16.6.1","ignore":"^7.0.5","openai":"^5.11.0","js-yaml":"^4.1.0","winston":"^3.17.0","tiktoken":"^1.0.21","node-cron":"^4.2.1","validator":"13.15.15","chrono-node":"^2.8.0","partial-json":"^0.1.7","sanitize-html":"^2.17.0","@duckdb/node-api":"^1.3.2-alpha.25","reflect-metadata":"^0.2.2","@hono/node-server":"^1.17.1","winston-transport":"^4.9.0","@supabase/supabase-js":"^2.53.0","@modelcontextprotocol/sdk":"^1.17.1","@opentelemetry/instrumentation-winston":"^0.48.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"msw":"^2.10.4","tsx":"^4.20.3","eslint":"^9.32.0","vitest":"^3.2.4","globals":"^16.3.0","typedoc":"^0.28.9","depcheck":"^1.4.7","prettier":"^3.6.2","@eslint/js":"^9.32.0","typescript":"^5.8.3","@types/node":"^24.1.0","@types/js-yaml":"^4.0.9","@faker-js/faker":"^9.9.0","@types/node-cron":"^3.0.11","@types/validator":"13.15.2","@anatine/zod-mock":"^3.14.0","typescript-eslint":"^8.38.0","@opentelemetry/api":"^1.9.0","@vitest/coverage-v8":"^3.2.4","vite-tsconfig-paths":"^5.1.4","@types/sanitize-html":"^2.16.0","@opentelemetry/sdk-node":"^0.203.0","@opentelemetry/resources":"^2.0.1","@opentelemetry/sdk-metrics":"^2.0.1","@opentelemetry/sdk-trace-node":"^2.0.1","@opentelemetry/semantic-conventions":"^1.36.0","@opentelemetry/exporter-trace-otlp-http":"^0.203.0","@opentelemetry/auto-instrumentations-node":"^0.62.0","@opentelemetry/exporter-metrics-otlp-http":"^0.203.0"},"_npmOperationalInternal":{"tmp":"tmp/jinaai-mcp-server_1.0.3_1754224918159_0.7678162909015072","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@cyanheads/jinaai-mcp-server","version":"1.0.4","description":"A Model Context Protocol (MCP) server that provides intelligent web reading capabilities using the Jina AI Reader API. It extracts clean, LLM-ready content from any URL.","main":"dist/index.js","types":"dist/index.d.ts","bin":{"jinaai-mcp-server":"dist/index.js"},"publishConfig":{"access":"public"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"type":"module","repository":{"type":"git","url":"git+https://github.com/cyanheads/jinaai-mcp-server.git"},"bugs":{"url":"https://github.com/cyanheads/jinaai-mcp-server/issues"},"homepage":"https://github.com/cyanheads/jinaai-mcp-server#readme","scripts":{"build":"tsc","postbuild":"tsx scripts/make-executable.ts dist/index.js","start":"node dist/index.js","start:stdio":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=stdio node dist/index.js","start:http":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=http node dist/index.js","start:agent":"MCP_LOG_LEVEL=debug node dist/agent/cli/boot.js","dev":"tsx --watch src/index.ts","dev:stdio":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=stdio tsx --watch src/index.ts","dev:http":"MCP_LOG_LEVEL=debug MCP_TRANSPORT_TYPE=http tsx --watch src/index.ts","dev:agent":"MCP_LOG_LEVEL=debug tsx --watch src/agent/cli/boot.ts","rebuild":"tsx scripts/clean.ts && npm run build","docs:generate":"typedoc --tsconfig ./tsconfig.typedoc.json","depcheck":"npx depcheck","lint":"eslint .","lint:fix":"eslint . --fix","typecheck":"tsc --noEmit","tree":"tsx scripts/tree.ts","fetch-spec":"tsx scripts/fetch-openapi-spec.ts","format":"prettier --write \"**/*.{ts,js,json,md,html,css}\"","inspector":"npx mcp-inspector --config mcp.json","test":"vitest run","test:watch":"vitest","test:coverage":"vitest run --coverage","audit":"npm audit --production","audit:fix":"npm audit fix --production","prepublishOnly":"npm run typecheck && npm run lint && npm run test && npm run build"},"dependencies":{"@hono/node-server":"^1.17.1","@modelcontextprotocol/sdk":"^1.17.1","@opentelemetry/instrumentation-winston":"^0.48.0","axios":"^1.11.0","chrono-node":"^2.8.0","dotenv":"^16.6.1","hono":"^4.8.9","ignore":"^7.0.5","jose":"^6.0.12","js-yaml":"^4.1.0","node-cron":"^4.2.1","openai":"^5.11.0","partial-json":"^0.1.7","reflect-metadata":"^0.2.2","sanitize-html":"^2.17.0","tiktoken":"^1.0.21","validator":"13.15.15","winston":"^3.17.0","winston-transport":"^4.9.0","zod":"^3.25.76"},"devDependencies":{"@anatine/zod-mock":"^3.14.0","@eslint/js":"^9.32.0","@faker-js/faker":"^9.9.0","@opentelemetry/api":"^1.9.0","@opentelemetry/auto-instrumentations-node":"^0.62.0","@opentelemetry/exporter-metrics-otlp-http":"^0.203.0","@opentelemetry/exporter-trace-otlp-http":"^0.203.0","@opentelemetry/resources":"^2.0.1","@opentelemetry/sdk-metrics":"^2.0.1","@opentelemetry/sdk-node":"^0.203.0","@opentelemetry/sdk-trace-node":"^2.0.1","@opentelemetry/semantic-conventions":"^1.36.0","@types/js-yaml":"^4.0.9","@types/node":"^24.1.0","@types/node-cron":"^3.0.11","@types/sanitize-html":"^2.16.0","@types/validator":"13.15.2","@vitest/coverage-v8":"^3.2.4","depcheck":"^1.4.7","eslint":"^9.32.0","globals":"^16.3.0","msw":"^2.10.4","prettier":"^3.6.2","tsx":"^4.20.3","typedoc":"^0.28.9","typescript":"^5.8.3","typescript-eslint":"^8.38.0","vite-tsconfig-paths":"^5.1.4","vitest":"^3.2.4"},"keywords":["typescript","mcp","model-context-protocol","agent","llm","ai-integration","mcp-server","jina","jina-ai","web-reader","content-extraction","scraping","llm-content-preparation","zod","opentelemetry","observability"],"author":{"name":"cyanheads","email":"casey@caseyjhand.com","url":"https://github.com/cyanheads/jinaai-mcp-server#readme"},"license":"Apache-2.0","funding":[{"type":"github","url":"https://github.com/sponsors/cyanheads"},{"type":"buy_me_a_coffee","url":"https://www.buymeacoffee.com/cyanheads"}],"engines":{"node":">=20.0.0"},"_id":"@cyanheads/jinaai-mcp-server@1.0.4","gitHead":"d96feacdb28cb7adcad2aa9a9ed02db122359549","_nodeVersion":"20.19.4","_npmVersion":"10.8.2","dist":{"integrity":"sha512-ulf7Z7cSSHJB609PYmQY/cDdq5nKyeuSOgTrw5eT20PjtoCEMFyOLeKULyH6yEQa0o+Zs27+J4R4KNRK8wqIDw==","shasum":"a7f941bb8f6a260f2364f0ae265f695508946bd9","tarball":"https://registry.npmjs.org/@cyanheads/jinaai-mcp-server/-/jinaai-mcp-server-1.0.4.tgz","fileCount":207,"unpackedSize":512958,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCo/S61ciKMp7O8bJmnkICN/8S8ESTOdr59HTc4jdf0wgIgKfnIeiSrhEHX5MXMYKZaFH7ZzLcKep6e7y0UiE8RAv8="}]},"_npmUser":{"name":"cyanheads","email":"casey@caseyjhand.com"},"directories":{},"maintainers":[{"name":"cyanheads","email":"casey@caseyjhand.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/jinaai-mcp-server_1.0.4_1754227415654_0.7803917583765936"},"_hasShrinkwrap":false}},"time":{"created":"2025-08-03T12:16:57.045Z","modified":"2025-08-03T13:23:36.031Z","1.0.2":"2025-08-03T12:16:57.299Z","1.0.3":"2025-08-03T12:41:58.356Z","1.0.4":"2025-08-03T13:23:35.863Z"},"bugs":{"url":"https://github.com/cyanheads/jinaai-mcp-server/issues"},"author":{"name":"cyanheads","email":"casey@caseyjhand.com","url":"https://github.com/cyanheads/jinaai-mcp-server#readme"},"license":"Apache-2.0","homepage":"https://github.com/cyanheads/jinaai-mcp-server#readme","keywords":["typescript","mcp","model-context-protocol","agent","llm","ai-integration","mcp-server","jina","jina-ai","web-reader","content-extraction","scraping","llm-content-preparation","zod","opentelemetry","observability"],"repository":{"type":"git","url":"git+https://github.com/cyanheads/jinaai-mcp-server.git"},"description":"A Model Context Protocol (MCP) server that provides intelligent web reading capabilities using the Jina AI Reader API. It extracts clean, LLM-ready content from any URL.","maintainers":[{"name":"cyanheads","email":"casey@caseyjhand.com"}],"readme":"\n\n# JinaAI MCP Server\n\n**An intelligent web reader tool powered by the Jina.ai Reader API, delivered as a production-grade Model Context Protocol (MCP) server.**\n\n[](https://www.typescriptlang.org/)\n[](https://modelcontextprotocol.io/)\n[](./CHANGELOG.md)\n[](./vitest.config.ts)\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://github.com/cyanheads/jinaai-mcp-server/issues)\n[](https://github.com/cyanheads/jinaai-mcp-server)\n\n
\n\nModel Context Protocol (MCP) Server providing a robust, developer-friendly interface to the [Jina.ai Reader API](https://jina.ai/reader). Enables LLMs and AI agents to read, process, and understand content from any webpage programmatically.\n\nBuilt on the [`cyanheads/mcp-ts-template`](https://github.com/cyanheads/mcp-ts-template), this server follows a modular architecture with robust error handling, logging, and security features.\n\n## π Core Capabilities: Jina AI Tools π οΈ\n\nThis server equips your AI with a specialized tool to interact with web content:\n\n| Tool Name | Description | Example |\n| :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------- |\n| [`jinaai_read_webpage`](./src/mcp-server/tools/jinaReader/) | Extracts and processes the main content from a given URL using Jina AI's ReaderLM engine. It returns a clean, markdown-formatted text representation of the content. | [View Example](./docs/jinaai_read_webpage_example.md) |\n\n---\n\n## Table of Contents\n\n| [Overview](#overview) | [Features](#features) | [Installation](#installation) |\n| :------------------------------ | :-------------------------------------- | :--------------------------------------------- |\n| [Configuration](#configuration) | [Project Structure](#project-structure) | [Development & Testing](#development--testing) |\n| [License](#license) | | |\n\n## Overview\n\nThe JinaAI MCP Server acts as a bridge, allowing applications that understand the Model Context Protocol (MCP)βlike advanced AI assistants, IDE extensions, or custom research toolsβto interact directly and efficiently with web content.\n\nInstead of dealing with raw HTML or complex scraping logic, your agents can leverage this server to:\n\n- **Automate Information Gathering**: Read articles, documentation, and other web content programmatically.\n- **Gain Deeper Understanding**: Access clean, LLM-ready text from any URL without leaving the host application.\n- **Integrate Web Content into AI Workflows**: Enable LLMs to perform research, summarize articles, and incorporate real-time web data into their responses.\n\n> **Developer Note**: This repository includes a [.clinerules](./.clinerules/clinerules.md) file that serves as a developer cheat sheet for your LLM coding agent with quick reference for the codebase patterns, file locations, and code snippets.\n\n## Features\n\n### Core Utilities\n\nLeverages the robust utilities provided by the `mcp-ts-template`:\n\n- **Logging**: Structured, configurable logging with sensitive data redaction.\n- **Error Handling**: Centralized error processing and standardized error types (`McpError`).\n- **Configuration**: Environment variable loading (`dotenv`) with validation using Zod.\n- **Input Validation**: Uses `zod` for all tool input schemas.\n- **Request Context**: End-to-end operation tracking via unique request IDs.\n- **Type Safety**: Enforced by TypeScript and Zod schemas.\n- **HTTP Transport**: High-performance HTTP server using **Hono**, featuring session management and authentication support.\n- **Authentication**: Robust authentication layer supporting JWT and OAuth 2.1.\n- **Observability**: Integrated **OpenTelemetry** for distributed tracing and metrics.\n\n### Jina AI Integration\n\n- **Intelligent Content Extraction**: Utilizes Jina's `readerlm-v2` engine to parse main content and remove boilerplate.\n- **Multiple Formats**: Supports output in Markdown, HTML, or plain text.\n- **Flexible Options**: Control over including links, images, and using the cache.\n\n## Installation\n\n### Prerequisites\n\n- [Node.js (>=18.0.0)](https://nodejs.org/)\n- [npm](https://www.npmjs.com/) (comes with Node.js)\n\n### MCP Client Settings\n\nAdd the following to your MCP client's configuration file (e.g., `cline_mcp_settings.json`).\nThis configuration uses `npx` to run the server, which will automatically install the package if not already present.\nThe `JINA_API_KEY` is required for the server to function.\n\n```json\n{\n \"mcpServers\": {\n \"jinaai-mcp-server\": {\n \"command\": \"npx\",\n \"args\": [\"@cyanheads/jinaai-mcp-server\"],\n \"env\": {\n \"MCP_TRANSPORT_TYPE\": \"http\",\n \"MCP_HTTP_PORT\": \"3018\",\n \"JINA_API_KEY\": \"YOUR_JINA_API_KEY_HERE\"\n }\n }\n }\n}\n```\n\n### From Source\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/cyanheads/jinaai-mcp-server.git\n cd jinaai-mcp-server\n ```\n2. Install dependencies:\n ```bash\n npm install\n ```\n3. Build the project:\n ```bash\n npm run build\n ```\n\n## Configuration\n\n### Environment Variables\n\nConfigure the server using environment variables. For local development, create a `.env` file at the project root.\n\n| Variable | Description | Default |\n| :------------------- | :------------------------------------------------------- | :------------ |\n| `JINA_API_KEY` | **Required.** Your API key for the Jina AI service. | (none) |\n| `MCP_TRANSPORT_TYPE` | Transport mechanism: `stdio` or `http`. | `stdio` |\n| `MCP_HTTP_PORT` | Port for the HTTP server (if `MCP_TRANSPORT_TYPE=http`). | `3018` |\n| `LOGS_DIR` | Directory for log file storage. | `logs/` |\n| `NODE_ENV` | Runtime environment (`development`, `production`). | `development` |\n\n## Project Structure\n\nThe codebase follows a modular structure within the `src/` directory:\n\n```\nsrc/\nβββ index.ts # Entry point: Initializes and starts the server\nβββ config/ # Configuration loading (env vars)\nβ βββ index.ts\nβββ mcp-server/ # Core MCP server logic and capability registration\nβ βββ server.ts # Server setup, tool registration\nβ βββ tools/ # MCP Tool implementations\nβ βββ jinaReader/ # The Jina AI Reader tool\nβββ utils/ # Common utility functions (logger, error handler, etc.)\n```\n\nFor a detailed file tree, run `npm run tree` or see [docs/tree.md](docs/tree.md).\n\n## Development & Testing\n\n### Development Scripts\n\n```bash\n# Build the project (compile TS to JS in dist/)\nnpm run build\n\n# Clean build artifacts and then rebuild the project\nnpm run rebuild\n\n# Format code with Prettier\nnpm run format\n```\n\n### Testing\n\nThis project uses [Vitest](https://vitest.dev/) for unit and integration testing.\n\n```bash\n# Run all tests once\nnpm test\n\n# Run tests in watch mode\nnpm run test:watch\n\n# Run tests and generate a coverage report\nnpm run test:coverage\n```\n\n### Running the Server\n\n```bash\n# Start the server using stdio (default)\nnpm run start:server\n\n# Start the server using HTTP transport\nnpm run start:server:http\n```\n\n## License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n\n---\n\n\n","readmeFilename":"README.md"}