Epub Mcp

by hhk-png

264 downloads
Not rated
GitHub

About

Epub Mcp is an MCP server that provides a set of tools for reading EPUB file contents. It is designed for use with MCP clients such as cline (formerly known as cline) and wraps the @lingo-reader/epub-parser library to expose EPUB reading capabilities as MCP tools.

Details

Author
hhk-png
Downloads
264
Categories
Other

- Initialize or reset an EPUB file (initEpubFile)
- Retrieve the collection list (getCollection)
- Get file information (getFileInfo)
- Obtain the manifest (getManifest)
- Read metadata (getMetadata)
- Navigate the nav list (getNavList)
- Get the page list (getPageList)
- Retrieve the spine (getSpine)
- Access the table of contents (getToc)
- Load a specific chapter (loadChapter)

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Epub Mcp
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install and run using npx -y epub-mcp or execute directly with Node.js via <Installation Directory>/node_modules/epub-mcp/dist/index.mjs. Configure it under mcpServers in your MCP client (e.g., cline) using the command/args syntax. On Windows use cmd /c npx -y epub-mcp for compatibility.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

McpServers

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

<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.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.