微信读书MCP Server 开源项目启动和配置文档

1. 项目的目录结构及介绍

微信读书MCP Server 是一个为微信读书提供 MCP（Model Context Protocol）服务的工具，它允许将微信读书的书籍、笔记和划线数据提供给支持 MCP 的大语言模型客户端，如 Cursor、Claude Desktop 等。以下是项目的目录结构：

.
├── .cache
├── src
│   ├── get_bookshelf.ts
│   ├── search_books.ts
│   ├── get_book_notes_and_highlights.ts
│   ├── get_book_best_reviews.ts
│   └── main.ts
├── .DS_Store
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── guide.md
├── package-lock.json
├── package.json
├── refapi.md
├── requirements.txt
├── tsconfig.json
└── guide.md

主要目录和文件介绍如下：

• .cache: 缓存目录，用于存储一些临时文件。
• src: 源代码目录，包含所有 TypeScript 源文件。
• .DS_Store: macOS 系统特有的目录，用于存储文件元数据。
• .gitignore: Git 忽略文件，用于指定 Git 仓库中哪些文件不被跟踪。
• CONTRIBUTING.md: 贡献者指南，指导如何为项目贡献代码。
• LICENSE: 许可证文件，声明项目的版权和许可信息。
• README.md: 项目说明文件，介绍项目的功能、使用方法和如何安装。
• guide.md: 项目使用指南，提供更详细的操作步骤和说明。
• package-lock.json 和 package.json: npm 包管理文件，用于管理项目依赖。
• refapi.md: 参考文档，详细说明项目提供的 API 接口。
• requirements.txt: 依赖文件，用于记录项目依赖的 Python 包。
• tsconfig.json: TypeScript 配置文件，用于指定 TypeScript 编译选项。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts。该文件使用 TypeScript 编写，负责加载项目依赖、配置环境变量和启动服务。以下是启动文件的主要内容：

import { app } from 'command-line-application';
import { getBookshelf, getBookNotesAndHighlights, getBookBestReviews, searchBooks } from './';

app
  .command('get_bookshelf')
  .description('获取用户书架上所有书籍')
  .action(getBookshelf);

app
  .command('search_books <keyword>')
  .description('通过关键词检索用户书架上的书籍')
  .action((keyword) => {
    searchBooks(keyword);
  });

app
  .command('get_book_notes_and_highlights <book_id>')
  .description('获取指定书籍的所有划线和笔记')
  .action((book_id) => {
    getBookNotesAndHighlights(book_id);
  });

app
  .command('get_book_best_reviews <book_id>')
  .description('获取指定书籍的热门书评')
  .action((book_id) => {
    getBookBestReviews(book_id);
  });

app.parse(process.argv);

启动文件使用 command-line-application 库来解析命令行参数，并执行相应的功能。例如，运行 mcp-server-weread get_bookshelf 命令会调用 getBookshelf 函数，获取用户书架上所有书籍的信息。

3. 项目的配置文件介绍

项目使用 package.json 和 tsconfig.json 作为配置文件。以下是对这两个文件的简要介绍：

• package.json: npm 包管理文件，用于管理项目依赖、定义项目脚本和配置相关信息。项目依赖的库和工具可以通过 npm install 命令安装。
• tsconfig.json: TypeScript 配置文件，用于指定 TypeScript 编译选项。例如，可以设置编译输出目录、指定编译器类型检查级别等。

此外，项目还支持通过环境变量来配置一些敏感信息，如微信读书账号的 Cookie。可以在 .env 文件中设置环境变量，例如：

WEREAD_COOKIE=your_wechat_read_cookie

然后在代码中通过 process.env.WEREAD_COOKIE 获取该环境变量的值。

总结：本文介绍了微信读书MCP Server 项目的目录结构、启动文件和配置文件。通过理解这些内容，可以更好地了解项目结构和使用方法，为后续的开发和配置提供帮助。