node-csfd-api 4.2.0-next.1 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
<div align="center">
|
|
8
8
|
|
|
9
|
-
# CSFD API 🎬
|
|
9
|
+
# CSFD API 🎬 + MCP Server 🤖
|
|
10
10
|
|
|
11
|
-
#### Modern TypeScript NPM library for scraping **
|
|
11
|
+
#### Modern TypeScript NPM library for scraping **CSFD.CZ**. Scraper, API, and MCP Server in one package. _(unofficial)_
|
|
12
12
|
|
|
13
|
-
[Features](#-features) • [Installation](#-installation) • [Quick Start](#-quick-start) • [API Reference](#-api-reference) • [Examples](#-usage-examples) • [Docker](#-docker-support)
|
|
13
|
+
[Features](#-features) • [Installation](#-installation) • [Quick Start](#-quick-start) • [API Reference](#-api-reference) • [Examples](#-usage-examples) • [MCP Server](#-mcp-server-model-context-protocol) • [Docker](#-docker-support)
|
|
14
14
|
|
|
15
15
|
</div>
|
|
16
16
|
|
|
@@ -22,14 +22,16 @@
|
|
|
22
22
|
- 🧪 **Well-tested** - ~100% code coverage
|
|
23
23
|
- 🚀 **Universal** - Works in Node.js, browsers, and serverless environments
|
|
24
24
|
- 🐳 **Docker ready** - Pre-built Docker images available
|
|
25
|
+
- 🤖 **MCP Server** - Use CSFD data directly within LLMs like Claude Desktop
|
|
25
26
|
- 🔄 **Modern API** - Promise-based with async/await support
|
|
26
|
-
- 📦 **
|
|
27
|
+
- 📦 **Few dependencies** - Lightweight and efficient
|
|
27
28
|
|
|
28
29
|
### Supported Platforms
|
|
29
30
|
|
|
30
31
|
- Node.js (ESM & CommonJS)
|
|
31
32
|
- Browsers (with CORS considerations)
|
|
32
33
|
- Docker containers
|
|
34
|
+
- MCP Server (Claude Desktop, etc.)
|
|
33
35
|
- Serverless (Firebase Functions, AWS Lambda, CloudFlare Workers, etc.)
|
|
34
36
|
- Chrome Extensions
|
|
35
37
|
- React Native (Yes, with Expo too!)
|
|
@@ -75,6 +77,7 @@ console.log(reviews);
|
|
|
75
77
|
- [Creators](#creators)
|
|
76
78
|
- [User Ratings](#user-ratings)
|
|
77
79
|
- [User Reviews](#user-reviews)
|
|
80
|
+
- [MCP Server](#-mcp-server-model-context-protocol)
|
|
78
81
|
- [Docker Support](#-docker-support)
|
|
79
82
|
- [Development](#-development)
|
|
80
83
|
|
|
@@ -517,6 +520,39 @@ const filtered = await csfd.userReviews(195357, {
|
|
|
517
520
|
|
|
518
521
|
Same options as [UserRatingsOptions](#userrationsoptions).
|
|
519
522
|
|
|
523
|
+
## 🤖 MCP Server (Model Context Protocol)
|
|
524
|
+
|
|
525
|
+
This library includes a built-in [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server. This allows you to use ČSFD data directly within LLMs like **Claude Desktop**.
|
|
526
|
+
|
|
527
|
+
### Features
|
|
528
|
+
|
|
529
|
+
- **Search**: Search for movies, TV series, and users.
|
|
530
|
+
- **Details**: Get comprehensive details about movies, creators, and users.
|
|
531
|
+
- **Reviews**: Read user reviews and ratings.
|
|
532
|
+
|
|
533
|
+
### Usage with Claude Desktop
|
|
534
|
+
|
|
535
|
+
Add the following configuration to your `claude_desktop_config.json`:
|
|
536
|
+
|
|
537
|
+
```json
|
|
538
|
+
{
|
|
539
|
+
"mcpServers": {
|
|
540
|
+
"csfd": {
|
|
541
|
+
"command": "npx",
|
|
542
|
+
"args": ["-y", "--package", "node-csfd-api", "csfd-mcp"]
|
|
543
|
+
}
|
|
544
|
+
}
|
|
545
|
+
}
|
|
546
|
+
```
|
|
547
|
+
|
|
548
|
+
### Supported Tools
|
|
549
|
+
|
|
550
|
+
- `search`: Search query (returns movies, series, users)
|
|
551
|
+
- `movie_details`: Get movie details by ID
|
|
552
|
+
- `creator_details`: Get creator details by ID
|
|
553
|
+
- `user_ratings`: Get user ratings
|
|
554
|
+
- `user_reviews`: Get user reviews
|
|
555
|
+
|
|
520
556
|
## 🐳 Docker Support
|
|
521
557
|
|
|
522
558
|
Run the CSFD API as a standalone REST service using Docker.
|