epub-mcp logo

epub-mcp

by hhk-png

This project is an MCP (Message Communication Protocol) tool specifically designed for reading EPUB file contents. It provides a way to interact with and extract information from EPUB files.

View on GitHub

Last updated: N/A

<a href="./README-zh.md">中文文档链接</a>

This project is an MCP related to EPUB files, providing an MCP tool for reading EPUB file contents.

Usage

the mcpServers configuration of cline:

{
  "mcpServers": {
    "epub-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "epub-mcp"
      ]
    }
  }
}

In windows env, we can use the following configuration:

{
  "mcpServers": {
    "epub-mcp": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "epub-mcp"
      ]
    }
  }
}

But the most reliable configuration is to use node to execute the corresponding file directly:

{
  "mcpServers": {
    "epub-mcp": {
      "command": "node",
      "args": [
        // the install path of `epub-mcp`
        "<Installation Directory>\\node_modules\\epub-mcp\\dist\\index.mjs"
      ]
    }
  }
}

Tools

reset or init epub(initEpubFile)

Parameters:

  • filePath: The absolute path of the file in the file system.

Returns

  • void
get collection-(getCollection)
get file info-(getFileInfo)
get manifest-(getManifest)
get metadata-(getMetadata)
get nav list-(getNavList)
get page list-(getPageList)
get spine-(getSpine)
get table of contents-(getToc)
load chapter-(loadChapter)

Parameters:

  • none

For detailed explanation of the above tools, please refer to: https://github.com/hhk-png/lingo-reader/blob/main/packages/epub-parser/README-zh.md. This MCP simply calls the api of @lingo-reader/epub-parser.