skilled-feishu-mcp/README.md

A Model Context Protocol (MCP) server that integrates with Feishu's Open Platform APIs

# SkilledFeishuMCP

A Model Context Protocol (MCP) server that integrates with Feishu's Open Platform APIs

## 项目概述

SkilledFeishuMCP是一个基于MCP协议的服务器，提供飞书文档相关的工具和API访问能力。项目包含两个主要组件：

1. **直接MCP服务器**：直接通过skilled-feishu-mcp可执行文件提供MCP接口
2. **桥接MCP服务器**：使用标准MCP SDK实现的桥接服务器，提供更加稳定和标准化的MCP接口

## 安装方式

### 全局安装

```bash
npm install -g skilled-feishu-mcp
```

### 本地安装

```bash
npm install skilled-feishu-mcp
```

## 使用方法

### 直接MCP服务器

```bash
# 基本用法
skilled-feishu-mcp --stdio --feishu-app-id=YOUR_APP_ID --feishu-app-secret=YOUR_APP_SECRET

# 开发模式
skilled-feishu-mcp --stdio --feishu-app-id=YOUR_APP_ID --feishu-app-secret=YOUR_APP_SECRET --development
```

### 桥接MCP服务器 (推荐)

桥接MCP服务器提供更加稳定的连接体验，使用官方MCP SDK实现，支持标准MCP协议：

```bash
# 基本用法
feishu-mcp-bridge --app-id=YOUR_APP_ID --app-secret=YOUR_APP_SECRET

# 开发模式
feishu-mcp-bridge --app-id=YOUR_APP_ID --app-secret=YOUR_APP_SECRET --development

# 指定skilled-feishu-mcp路径
feishu-mcp-bridge --app-id=YOUR_APP_ID --app-secret=YOUR_APP_SECRET --server-path=/path/to/skilled-feishu-mcp
```

## 在Claude或其他AI应用中使用

在Claude Desktop的配置文件中添加如下内容：

```json
{
  "mcpServers": {
    "feishu": {
      "command": "feishu-mcp-bridge",
      "args": [
        "--stdio",
        "--app-id", "YOUR_APP_ID",
        "--app-secret", "YOUR_APP_SECRET",
        "--development"
      ]
    }
  }
}
```

## 可用工具

桥接MCP服务器提供以下工具：

- `create_feishu_document` - 创建新的飞书文档
- `get_feishu_doc_info` - 获取飞书文档基本信息
- `get_feishu_doc_content` - 获取飞书文档的纯文本内容
- `get_feishu_doc_blocks` - 获取飞书文档的块结构信息
- `get_feishu_block_content` - 获取飞书文档中特定块的内容
- `update_feishu_block_text` - 更新飞书文档中特定块的文本内容
- `create_feishu_multiple_blocks` - 在飞书文档中创建多个块
- `list_tools` - 列出所有可用的工具

## 环境变量

可以通过环境变量来配置服务：

- `FEISHU_APP_ID` - 飞书应用ID
- `FEISHU_APP_SECRET` - 飞书应用密钥
- `SKILLED_FEISHU_MCP_PATH` - skilled-feishu-mcp可执行文件路径
- `NODE_ENV` - 设置为"development"启用开发模式
- `LOG_LEVEL` - 日志级别 (error, warn, info, debug)

## 开发和构建

```bash
# 安装依赖
npm install

# 开发模式运行直接服务器
npm run dev

# 开发模式运行桥接服务器
npm run dev:bridge

# 构建项目
npm run build

# 运行测试
npm test
```

## 许可证

MIT