Skills · Publisher repository

WeChatReading

Tencent's official WeChat Reading Agent Skills use a unified API Gateway for book search, bookshelf access, reading progress, notes, reading statistics, public reviews, and personalized recommendations.

181 StarsApache-2.0Updated 1 months ago
01

Project overview

WeChatReading is Tencent's public collection of WeChat Reading Agent Skills. A single Agent API Gateway exposes workflows for search, book details, bookshelf data, reading progress, personal notes and highlights, reading statistics, public reviews, and personalized recommendations. The repository is primarily documented in Chinese and requires an API key bound to the user's WeChat Reading identity.

02

Core capabilities

01

Multi-scope catalog search

search.md documents scopes for ebooks, web novels, audiobooks, authors, full text, book lists, Official Accounts, and articles, with intent-based routing rules.

02

Books, bookshelf, and reading progress

book.md and shelf.md cover book details, chapter lists, reading progress, and counting rules for ebooks, audiobook albums, and the saved-article entry.

03

Notes, highlights, and reviews

notes.md separates personal notes, highlights, thoughts, and public reviews while documenting notebook summaries, highlight exports, popular highlights, and related thoughts.

04

Reading statistics and recommendations

readdata.md defines reading-time and preference statistics, while discover.md documents personalized and similar-book recommendations.

03

Installation and usage

Run the repository's global installation command, obtain an API key from the official WeChat Reading entry point, set it as WEREAD_API_KEY, and begin with a read-only interface listing or public book search.

AI AGENT INSTALL

Let an AI Agent install it

Send this prompt to Codex, Claude Code, or another AI agent that can work with your local environment.

Help me install Tencent's WeChatReading Agent Skills from https://github.com/Tencent/WeChatReading. First read README.md, skills/SKILL.md, and LICENSE, verify the current version and exact installation command, then run `npx skills add Tencent/WeChatReading -g`. Ask before overwriting any existing Skill directory. After installation, confirm that the host discovers `weread-skills`. When WEREAD_API_KEY is required, explain which personal reading data it can expose and ask me for authorization; never place the credential in source control, logs, or chat transcripts. Once authorized, run a minimal read-only `/_list` or public book-search check and report discovery separately from the real API result. Ask first before requesting credentials, extra permissions, overwriting files, or performing any risky action.
01Before you start
  • An agent host that can run the documented npx command and load Agent Skills
  • A WeChat Reading account and an API key from the official entry point linked in the README
  • A secure way to set environment variables without committing or exposing the API key
02Copy the install command or configuration
npx skills add Tencent/WeChatReading -g
03Complete the setup steps
  1. 1
    Install the official Skills

    Run `npx skills add Tencent/WeChatReading -g` in the target agent host. Check for an existing directory and ask before replacing it.

  2. 2
    Obtain and configure the API key

    Use the official WeChat Reading entry point linked in the README and set the result as the WEREAD_API_KEY environment variable. Keep the real value out of source code, Git, logs, and shareable prompts.

  3. 3
    Confirm Skill discovery

    Restart or refresh the host and confirm that it recognizes `weread-skills`. This validates installation discovery, not remote API behavior or personal-data access.

  4. 4
    Run a minimal read-only check

    Query `/_list` or search for a public book first. Obtain explicit scope authorization before accessing a user's bookshelf, notes, progress, statistics, or personalized recommendations.

How to verify the setup

Confirm that the host discovers `weread-skills`, then send `{'api_name':'/_list','skill_version':'1.0.4'}` or perform a public book search. An interface list or real search result confirms the functional path; merely seeing the Skill name confirms discovery only.

Before using it
  • The API key is bound to a WeChat Reading identity and belongs in an environment variable or secure host storage
  • Bookshelf data, progress, personal notes, statistics, and recommendations can reveal private reading history and interests
  • Every request must include skill_version 1.0.4; handle upgrade_info before retrying
  • The repository contains no explanatory screenshots, examples, or diagrams, so this page intentionally has no body media
04

Use cases

SCENARIO 01

Search books and reading information

Search books, authors, full text, lists, or audiobooks, then inspect details, chapters, and reading progress.

SCENARIO 02

Organize a personal bookshelf and notes

With authorization, inspect bookshelf composition, summarize personal notebooks, or export highlights and thoughts from one book.

SCENARIO 03

Review reading habits

Query reading time, active days, rankings, and preferences for monthly or yearly reading reviews.

SCENARIO 04

Discover the next book

Use personalized or similar-book recommendations together with ratings, public reviews, and popular highlights.

05

Assessment

Based on Tencent's public README, Skill entry, and capability documentation, WeChatReading has a straightforward installation path and unusually explicit rules for parameter layout, version reporting, and bookshelf counting. The tradeoff is dependence on a remote service and a user-bound API key that can expose sensitive reading data. This assessment is based on public materials only; the Skill was not installed and no real account API was called.

Why it may be useful

  • Official Tencent repository with public installation, version, license, and API documentation
  • Separate workflow and field documentation for search, bookshelf, notes, statistics, reviews, and recommendations
  • Environment-variable API key handling plus explicit upgrade and error rules
  • Apache-2.0 supports inspection, modification, and redistribution under its terms

What to know first

  • Requires Tencent's remote Agent API Gateway and a valid API key
  • Bookshelf, progress, notes, statistics, and recommendations can reveal private reading interests
  • The README does not enumerate a specific agent-host compatibility matrix
  • Installation and real functional behavior were not tested in this review
06

README

WeChatReading


Overview

Tencent's official WeChat Reading Agent Skills use a unified API Gateway for book search, bookshelf access, reading progress, notes, reading statistics, public reviews, and personalized recommendations.

Getting started

  • Run the repository's global installation command, obtain an API key from the official WeChat Reading entry point, set it as WEREAD_API_KEY, and begin with a read-only interface listing or public book search.
  • The README installs globally with `npx skills add Tencent/WeChatReading -g` and configures a WEREAD_API_KEY environment variable.
  • The Skill sends JSON requests to `https://i.weread.qq.com/api/agent/gateway`, with business parameters at the same level as api_name and skill_version.
  • Confirm that the host discovers `weread-skills`, then send `{'api_name':'/_list','skill_version':'1.0.4'}` or perform a public book search. An interface list or real search result confirms the functional path; merely seeing the Skill name confirms discovery only.

Configuration

npx skills add Tencent/WeChatReading -g
Read the complete README on GitHub