article
README
🚀 微信读书模型上下文协议服务器(MCP Server)
这是一个用于与微信读书(WeRead)API交互的工具,旨在助力大语言模型客户端(LLM clients)获取并处理微信读书的数据,可获取用户书架信息、搜索特定类别书籍以及获取指定书籍的笔记和标注。
🚀 快速开始
本工具可帮助大语言模型客户端与微信读书API交互,获取和处理微信读书的数据。使用前需完成安装和环境变量配置。
✨ 主要特性
- 获取书架信息:返回用户微信读书账号下的所有书籍信息,涵盖书名、作者、阅读进度等。
- 搜索书籍:依据关键词搜索书架中的书籍,支持模糊匹配。
- 获取笔记和标注:返回指定书籍的笔记和标注信息,按章节组织。
1. 获取书架信息(get_bookshelf)
- 功能描述:返回用户微信读书账号下的所有书籍信息,包括书名、作者、阅读进度等。
- 示例输出:
{
"total_books": 208,
"books": [
{
"title": "隐藏的自我",
"author": "大卫·伊格曼",
"progress": 100,
"isbn": "9787536684455"
},
...
]
}
2. 搜索书籍(search_books)
- 功能描述:根据关键词搜索书架中的书籍,支持模糊匹配。
- 输入参数:
keyword:需要搜索的关键词max_results(可选):返回的最大结果数,默认为10
- 示例输出:
[
{
"title": "思考,快与慢",
"author": "丹尼尔·卡尼曼",
"progress": 75,
"isbn": "9787208056432"
},
...
]
3. 获取笔记和标注(get_book_notes_and_highlights)
- 功能描述:返回指定书籍的笔记和标注信息,按章节组织。
- 输入参数:
book_id:需要查询的书籍ID
- 示例输出:
{
"chapter_1": [
{
"type": "highlight",
"content": "系统1的运行是无意识且快速的,不怎么费脑力..."
},
{
"type": "note",
"content": "系统1负责直觉和快速判断,系统2负责缓慢的理性思考。"
}
},
...
}
📦 安装指南
先决条件
- 操作系统:支持Linux、Windows、macOS
- 依赖项:
- Python >=3.6
- requests库
- configargparse库
安装步骤
- 克隆代码仓库到本地:
git clone https://github.com/yourusername/we-read-mcp.git
cd we-read-mcp
- 安装依赖项:
pip install requests configargparse
- 配置环境变量或创建配置文件(见下文)。
- 运行主程序:
python main.py
环境变量配置
可以通过以下方式配置:
- 方式一:编辑
config.json
{
"cookie": "填写你的微信读书Cookie",
"proxy": "http://your-proxy-server:port"
}
- 方式二:设置环境变量
export WEREAD_COOKIE="填写你的微信读书Cookie"
export WEREAD_PROXY="http://your-proxy-server:port"
💻 使用示例
基础用法
示例1 - 获取书架信息
python main.py --command get_bookshelf
输出:
{
"total_books": 208,
"books": [
{
"title": "隐藏的自我",
"author": "大卫·伊格曼",
"progress": 100,
"isbn": "9787536684455"
},
...
]
}
示例2 - 搜索书籍
python main.py --command search_books --keyword "心理学" --max_results 5
输出:
[
{
"title": "思考,快与慢",
"author": "丹尼尔·卡尼曼",
"progress": 75,
"isbn": "9787208056432"
},
...
]
示例3 - 获取笔记和标注
python main.py --command get_book_notes_and_highlights --book_id "9787208056432"
输出:
{
"chapter_1": [
{
"type": "highlight",
"content": "系统1的运行是无意识且快速的,不怎么费脑力..."
},
{
"type": "note",
"content": "系统1负责直觉和快速判断,系统2负责缓慢的理性思考。"
}
},
...
}
📚 详细文档
注意事项
- 需要获取有效的微信读书Cookie才能使用。
- 如果需要代理,请确保配置正确的代理信息。
- 使用过程中请遵守微信读书的服务条款。
📄 许可证
本项目采用MIT License协议开源。
Scan to contact