@xzxzzx/bilibili-mcp 1.2.0 → 1.3.0

package/README.md

@@ -6,6 +6,9 @@
 
 用claude code(glm4.7模型)做的总结B站视频的MCP(经过antigravity里的claude,gemini模型修改bug)(提取字幕与评论)
 
+> [!TIP]
+> ⚠️ **快速开始**：使用前请务必配置您的 B 站 Cookie，否则将无法提取视频字幕与评论。详见 [**⚙️ 凭证配置**](#️-凭证配置)。
+
 View this document in [English](./README_EN.md).
 
 ---
@@ -14,6 +17,7 @@ View this document in [English](./README_EN.md).
 
 - [Bilibili MCP Tool](#bilibili-mcp-tool)
   - [📑 目录](#-目录)
+  - [⚡ 快速预检](#-快速预检)
   - [🌟 功能特性](#-功能特性)
     - [1. 视频总结 (`get_video_info`)](#1-视频总结-get_video_info)
     - [2. 评论总结 (`get_video_comments`)](#2-评论总结-get_video_comments)
@@ -32,8 +36,10 @@ View this document in [English](./README_EN.md).
     - [🪐 Antigravity (Google 官方 IDE)](#-antigravity-google-官方-ide)
     - [📦 OpenCode](#-opencode)
   - [⚙️ 凭证配置](#️-凭证配置)
-    - [方式 A：使用 CLI 向导（推荐）](#方式-a使用-cli-向导推荐)
-    - [方式 B：手动配置环境变量](#方式-b手动配置环境变量)
+    - [🔑 第一步：获取 Bilibili Cookie](#-第一步获取-bilibili-cookie)
+    - [📝 第二步：应用凭证](#-第二步应用凭证)
+      - [方式 A：使用 CLI 向导（推荐，适用于全局安装）](#方式-a使用-cli-向导推荐适用于全局安装)
+      - [方式 B：手动配置环境变量（适用于本地开发或 Docker）](#方式-b手动配置环境变量适用于本地开发或-docker)
       - [🔒 安全须知](#-安全须知)
   - [💡 工具使用示例](#-工具使用示例)
   - [🛡️ API 限流机制](#️-api-限流机制)
@@ -43,6 +49,16 @@ View this document in [English](./README_EN.md).
 
 ---
 
+## ⚡ 快速预检
+
+> [!IMPORTANT]
+> **本工具需要 Bilibili 凭证 (Cookie) 才能发挥完整功能。**
+> 如果没有正确配置凭证，您可能无法获取视频字幕、评论
+
+在开始安装前，请确保您已经了解[如何获取并配置 Cookie](#️-凭证配置)。
+
+---
+
 ## 🌟 功能特性
 
 ### 1. 视频总结 (`get_video_info`)
@@ -279,41 +295,53 @@ OpenCode 用户可以通过编辑配置文件接入：
 
 ---
 
+---
+
 ## ⚙️ 凭证配置
 
-为了获取更完整的评论数据或避免匿名访问限制，建议配置 B 站 Cookie。
+为了获取更完整的评论数据、绕过匿名访问限制并确保工具稳定运行，**必须**配置 B 站 Cookie。
+
+### 🔑 第一步：获取 Bilibili Cookie
 
-### 方式 A：使用 CLI 向导（推荐）
-如果您全局安装了 npm 包，直接运行：
+1. 在电脑浏览器登录 [bilibili.com](https://www.bilibili.com)
+2. 按 `F12` 打开开发者工具（或在页面右键选择“检查”）。
+3. 切换到 **Application (应用)** 选项卡 -> 在左侧菜单找到 **Cookies** -> 点击 `https://www.bilibili.com`。
+4. 在右侧列表中找到以下三个关键变量，并记录它们的 **Value**：
+    - `SESSDATA`
+    - `bili_jct` (即 CSRF Token)
+    - `DedeUserID` (您的用户数字 ID)
+
+> [!TIP]
+> 如果您在 `Application` 找不到，也可以查看 `Network` (网络) 选项卡中的任意一个请求，在 `Headers` -> `Cookie` 字段中也能找到这些值。
+
+### 📝 第二步：应用凭证
+
+您可以针对不同的使用习惯选择以下任一方式：
+
+#### 方式 A：使用 CLI 向导（推荐，适用于全局安装）
+如果您全局安装了 npm 包（`npm i -g @xzxzzx/bilibili-mcp`），直接运行：
 ```bash
 bilibili-mcp config
 ```
-交互向导将引导您输入凭证并安全保存在**本地**配置目录（`~/.bilibili-mcp/config.json`）中，**不会被上传至任何服务器**。
+交互向导将引导您输入凭证并安全保存在**本地**配置目录（`~/.bilibili-mcp/config.json`）中。
 
-### 方式 B：手动配置环境变量
-
-在项目根目录创建 `.env` 文件（或在 shell 中设置），手动填入以下变量：
+#### 方式 B：手动配置环境变量（适用于本地开发或 Docker）
+在项目根目录创建 `.env` 文件，手动填入以下变量：
 
 | 变量名 | 说明 |
 | :--- | :--- |
-| **BILIBILI_SESSDATA** | 会话数据 (SESSDATA) |
-| **BILIBILI_BILI_JCT** | 跨站令牌 (bili_jct) |
-| **BILIBILI_DEDEUSERID** | 用户 ID (DedeUserID) |
-
-<details>
-<summary>💡 点击查看如何获取 Bilibili Cookie</summary>
+| **BILIBILI_SESSDATA** | `SESSDATA` 的值 |
+| **BILIBILI_BILI_JCT** | `bili_jct` 的值 |
+| **BILIBILI_DEDEUSERID** | `DedeUserID` 的值 |
 
-1. 在电脑浏览器登录 [bilibili.com](https://www.bilibili.com)
-2. 按 `F12` 打开开发者工具（或在页面右键选择“检查”）。
-3. 切换到 **Application (应用)** 选项卡 -> 在左侧菜单找到 **Cookies** -> 点击 `https://www.bilibili.com`。
-4. 在右侧列表中找到 `SESSDATA`、`bili_jct` 和 `buvid3`，复制其对应的 **Value** 即可。
-</details>
+> [!WARNING]
+> `.env` 文件仅供本地加载，**切勿提交到 Git 或公开仓库**。
 
 #### 🔒 安全须知
 
-- **本地存储**：您的凭证信息（Cookie）仅存储在您的本地设备上（环境变量或本地配置文件），本工具**绝不会**将其上传至除 Bilibili 官方 API 以外的任何第三方服务器。
-- **配置隔离**：`.env` 文件已被 `.gitignore` 排除，**请勿手动提交到公开代码库**。
-- **时效性**：Cookie 具有时效性，若遇到权限错误请考虑重新获取并配置。
+- **隐私保护**：您的凭证信息仅存储在您的本地设备上。本工具**绝不会**将其上传至除 Bilibili 官方 API 以外的任何第三方服务器。
+- **配置隔离**：`.env` 文件已被 `.gitignore` 排除。
+- **时效性**：Cookie 具有时效性。若遇到 `412` 或权限错误，请尝试更新 Cookie。
 
 ---
 

package/README_EN.md

@@ -6,6 +6,9 @@
 
 A Bilibili video auxiliary MCP tool built based on mainstream AI development tools like Claude Code, Cursor, Trae, and Google Antigravity. It aims to quickly extract core video information, highlights, and popular comments through Large Language Model capabilities, helping you process audio and video content efficiently.
 
+> [!TIP]
+> ⚠️ **Quick Start**: Please make sure to configure your Bilibili Cookies before use, otherwise video subtitles and comments cannot be extracted. See [**⚙️ Credential Configuration**](#⚙️-credential-configuration).
+
 View this document in [简体中文](./README.md).
 
 ---
@@ -32,6 +35,16 @@ View this document in [简体中文](./README.md).
 
 ---
 
+## ⚡ Pre-check
+
+> [!IMPORTANT]
+> **This tool requires Bilibili Credentials (Cookies) to function fully.**
+> Without proper credentials, you may face issues retrieving subtitles, popular comments, or encounter frequent API rate limiting.
+
+Before proceeding with installation, please ensure you are familiar with [How to obtain and configure Cookies](#⚙️-credential-configuration).
+
+---
+
 ## 🌟 Features
 
 ### 1. Video Summarization (`get_video_info`)
@@ -258,39 +271,52 @@ Edit the config file:
 
 ---
 
+---
+
 ## ⚙️ Credential Configuration
 
-Configure Bilibili Cookies for full comment data and to avoid anonymous limits.
+To retrieve full comment data, bypass anonymous access limits, and ensure stability, you **must** configure Bilibili Cookies.
+
+### 🔑 Step 1: Obtain Bilibili Cookies
+
+1. Log in to [bilibili.com](https://www.bilibili.com) in your desktop browser.
+2. Press `F12` to open Developer Tools (or right-click and select "Inspect").
+3. Go to the **Application** tab -> Find **Cookies** in the left menu -> Click `https://www.bilibili.com`.
+4. Locate the following three key variables and record their **Value**:
+    - `SESSDATA`
+    - `bili_jct` (also known as CSRF Token)
+    - `DedeUserID` (your numerical User ID)
+
+> [!TIP]
+> If you can't find them in the `Application` tab, check the `Network` tab for any request, and look for the `Cookie` field under `Headers`.
 
-### Method A: CLI Wizard (Recommended)
-If installed via npm, run:
+### 📝 Step 2: Apply Credentials
+
+Choose one of the following methods based on your preference:
+
+#### Method A: CLI Wizard (Recommended, for global installations)
+If installed via npm (`npm i -g @xzxzzx/bilibili-mcp`), run:
 ```bash
 bilibili-mcp config
 ```
-This wizard will guide you to enter credentials and save them **locally** (`~/.bilibili-mcp/config.json`). They are **never uploaded to any server**.
+The interactive wizard will guide you through entering credentials and save them **locally** (`~/.bilibili-mcp/config.json`).
 
-### Method B: Manual Environment Variables
-Create a `.env` file in the project root (or set in shell):
+#### Method B: Manual Environment Variables (for local development or Docker)
+Create a `.env` file in the project root and enter the following variables:
 
 | Variable | Description |
 | :--- | :--- |
-| **BILIBILI_SESSDATA** | Session Data (SESSDATA) |
-| **BILIBILI_BILI_JCT** | CSRF Token (bili_jct) |
-| **BILIBILI_DEDEUSERID** | User ID (DedeUserID) |
-
-<details>
-<summary>💡 How to get Bilibili Cookies</summary>
+| **BILIBILI_SESSDATA** | Value of `SESSDATA` |
+| **BILIBILI_BILI_JCT** | Value of `bili_jct` |
+| **BILIBILI_DEDEUSERID** | Value of `DedeUserID` |
 
-1. Login to [bilibili.com](https://www.bilibili.com) in your browser.
-2. Press `F12` for Developer Tools.
-3. Go to **Application** tab -> **Cookies** -> `https://www.bilibili.com`.
-4. Copy values for `SESSDATA`, `bili_jct`, and `DedeUserID`.
-</details>
+> [!WARNING]
+> The `.env` file is for local use only. **Never commit it to Git or any public repository.**
 
 #### 🔒 Security Notice
-- **Local Storage**: Your credentials are only stored on your local device.
-- **Config Isolation**: `.env` is ignored by git. **Do not commit it to public repos**.
-- **Expiration**: Cookies expire; re-acquire them if you encounter permission errors.
+- **Privacy**: Your credentials are only stored on your local device. This tool **never** uploads them to any third-party server besides official Bilibili APIs.
+- **Isolation**: The `.env` file is excluded by `.gitignore`.
+- **Expiration**: Cookies expire over time. If you encounter `412` or permission errors, try updating your cookies.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xzxzzx/bilibili-mcp",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Bilibili MCP tool for video and comment summarization",
   "type": "module",
   "main": "dist/index.js",