Feishu Doc MCP

🚀 Feishu Doc MCP

A Model Context Protocol (MCP) server for accessing Feishu Open Platform documents. This server enables AI assistants like Claude to directly search and read Feishu API documents.

🚀 Quick Start

Why Choose Feishu Doc MCP

Zero Configuration, No API Key Required

It directly connects to the officially public document interfaces of Feishu, eliminating the need to apply for any Tokens or API Keys. It's ready to use right out of the box.

Dynamic Synchronization, Always Up-to-Date

The classification list is fetched in real-time from the Feishu API, automatically adapting to changes in the official document structure without the burden of hard-coded maintenance. When Feishu adds or adjusts API classifications, this tool synchronizes automatically.

Comprehensive Coverage, Over 4800 Documents

It supports the entire document system of the Feishu Open Platform, including over 100 categories such as server-side APIs, client-side APIs, development guides, and development tutorials, covering all capabilities like instant messaging, calendars, address books, cloud documents, approvals, and human resources.

Intelligent Content Processing

• Automatically prompts for segmented reading of large files to protect the context window.
• Intelligently names temporary files (readable prefix + Hash) to avoid conflicts.

High-Performance Design

• Loads document indexes and URI mappings in parallel during startup.
• Caches mappings of over 4800 documents in memory, with a query time complexity of O(1).
• Supports long-term operation without repeated initialization.

✨ Features

• Search Feishu API documents by category.
• Read detailed document content.
• Support multiple API categories:
  • Server-side APIs (messages, calendars, address books, etc.)
  • Client-side APIs (web applications, mini-programs, etc.)
  • Development guides (bots, web applications, etc.)
  • And more...

📦 Installation

Using npx (Recommended)

No need to install. Run directly using npx:

npx feishu-doc-mcp@latest

Use @latest to ensure you get the latest version each time you run it.

Global Installation

npm install -g feishu-doc-mcp

Then run:

feishu-doc-mcp

💻 Usage Examples

Using in Claude Desktop

Add the following configuration to the Claude Desktop configuration file:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "feishu-doc": {
      "command": "npx",
      "args": ["feishu-doc-mcp@latest"]
    }
  }
}

If you installed it globally:

{
  "mcpServers": {
    "feishu-doc": {
      "command": "feishu-doc-mcp"
    }
  }
}

Available Tools

search_feishu_doc

Search Feishu API documents by category and return the document list under that category.

Parameters:

• category: Document category, formatted as "First-level Directory_Second-level Directory" (e.g., "Server-side API_Instant Messaging", "Development Guide_Developing Bots").

read_feishu_doc

Read the detailed content of Feishu API documents. The content will be saved to a temporary file for access.

Parameters:

• path: Document path (obtained from the results of search_feishu_doc).

📚 Documentation

Development

# Install dependencies
npm install

# Build
npm run build

# Run in development mode
npm run dev

# Start the server
npm start

Release

This project uses GitHub Actions to automatically publish to npm. To release a new version:

1. Update the version number in package.json.
2. Commit the changes.
3. Create and push a tag:

   git tag v1.0.1
   git push origin v1.0.1
   

4. GitHub Actions will automatically build and publish to npm.

Environment Requirements

• Node.js >= 18

Changelog

v1.0.7

• feat: Split large documents by secondary headings for easier segmented reading.
• feat: Save request example files under the document directory for better file organization.

v1.0.6

• feat: Clean up md-* tags and extra empty lines in Markdown content.
• feat: Extract SDK request examples in each language and save them separately.

v1.0.5

• refactor: Remove the turndown dependency to simplify the code.

📄 License

MIT

Author

ztxtxwd