Markdown To Text

Markdown 转文本 MCP 服务

一个功能强大的模型上下文协议（MCP）服务，可将 Markdown 文档转换为纯文本。支持 stdio 和 HTTP 传输协议，可用作本地工具或远程服务。

功能

• 📝 完整的 Markdown 支持：处理所有常见元素，包括标题、列表、链接、图片、代码块、表格等。
• 🎛️ 灵活的转换选项：支持多种输出格式和样式配置
• 🔧 双协议支持：stdio 模式（Claude Desktop）和 HTTP 模式（远程客户端）
• 📁 批量处理：扫描目录并批量转换文件
• 🌐 URL 支持：直接处理远程 Markdown 文件
• 🔒 强化安全性：全面的输入验证和安全防护
• ⚡ 高性能：经过优化的转换引擎，支持并发控制

快速开始

安装

选项 1：克隆并构建

git clone <repository-url>
cd md_to_text_mcp
npm install
npm run build

选项 2：使用 npx（推荐）

# From npm registry (if published)
npx md_to_text_mcp --help

# From GitHub repository  
npx https://github.com/MD-TO-TEXT/md_to_text --help

# Local development
npm pack
npx ./md_to_text_mcp-1.0.0.tgz --help

基本用法

# Stdio mode (default)
npm start
# or with npx
npx md_to_text_mcp

# HTTP mode
npm run dev:http
# or with npx  
npx md_to_text_mcp --mode http --port 3000

使用 npx

npx 允许你运行工具，而无需全局安装。使用方法如下：

快速测试

# Test the tool help
npx md_to_text_mcp --help

# Run in stdio mode for Claude Desktop
npx md_to_text_mcp --mode stdio

# Start HTTP server
npx md_to_text_mcp --mode http --port 3000

# Custom configuration
npx md_to_text_mcp --mode http --host 0.0.0.0 --port 8080 --cors

使用本地软件包

如果你在本地开发：

# Create package
npm run build
npm pack

# Run with npx
npx ./md_to_text_mcp-1.0.0.tgz --help
npx ./md_to_text_mcp-1.0.0.tgz --mode stdio

通过 npx 与 Claude Desktop 集成

你可以配置 Claude Desktop，通过 npx 使用该工具：

{
  "mcpServers": {
    "md-to-text": {
      "command": "npx",
      "args": ["md_to_text_mcp", "--mode", "stdio"],
      "cwd": "/tmp"
    }
  }
}

注意：在 Claude Desktop 配置中使用 npx，要求该软件包已发布到 npm 注册表或可从 Git 仓库获取。

工具

convert_text - 文本转换

将 Markdown 文本直接转换为纯文本。

convert_file - 文件转换

读取并转换本地 Markdown 文件。

convert_url - URL 转换

从 URL 获取远程 Markdown 内容并进行转换。

batch_convert - 批量转换

批量处理目录中的 Markdown 文件。

转换选项

• preserveLinks：保留链接 URL
• listStyle：列表样式（项目符号/数字/无）
• codeHandling：代码处理方式（保留/移除/行内）
• tableFormat：表格格式（简单/网格/无）
• headingStyle：标题样式（井号/下划线/无）

Claude Desktop 集成

添加到 Claude for Desktop 配置文件：

{
  "mcpServers": {
    "md-to-text": {
      "command": "node",
      "args": ["./build/index.js"],
      "cwd": "/path/to/md_to_text_mcp"
    }
  }
}

命令行选项

md-to-text-mcp [OPTIONS]

OPTIONS:
  --mode <mode>         Server mode: 'stdio' or 'http' (default: stdio)
  --port <port>         HTTP server port (default: 3000)
  --host <host>         HTTP server host (default: localhost)
  --cors                Enable CORS for HTTP mode
  --no-cors             Disable CORS for HTTP mode
  --help, -h            Show help message

EXAMPLES:
  md-to-text-mcp                              # stdio mode
  md-to-text-mcp --mode http --port 3000      # HTTP mode
  md-to-text-mcp --mode http --host 0.0.0.0   # Allow external access

环境变量

变量	描述	默认值
MCP_MODE	服务模式（stdio/http）	stdio
MCP_PORT	HTTP 服务端口	3000
MCP_HOST	HTTP 服务主机	localhost
MAX_FILE_SIZE	最大文件大小（字节）	10485760（10MB）
URL_TIMEOUT	URL 请求超时（毫秒）	30000（30s）
ALLOWED_EXTENSIONS	允许的文件扩展名	.md,.markdown,.txt

Docker 支持

# Build image
docker build -t md-to-text-mcp .

# Run HTTP mode
docker run -p 3000:3000 md-to-text-mcp

# Health check
curl http://localhost:3000/health

API 示例

文本转换

{
  "name": "convert_text",
  "arguments": {
    "markdown": "# Hello World\n\nThis is **bold** text.",
    "options": {
      "preserveLinks": true,
      "listStyle": "bullets"
    }
  }
}

文件转换

{
  "name": "convert_file",
  "arguments": {
    "path": "/path/to/document.md",
    "options": {
      "headingStyle": "underline"
    }
  }
}

URL 转换

{
  "name": "convert_url",
  "arguments": {
    "url": "https://raw.githubusercontent.com/user/repo/main/README.md",
    "options": {
      "codeHandling": "remove"
    }
  }
}

批量转换

{
  "name": "batch_convert",
  "arguments": {
    "directory": "/path/to/docs",
    "recursive": true,
    "options": {
      "tableFormat": "simple"
    }
  }
}

安全性

该服务包含多层安全防护：

• 路径遍历防护：防止访问系统目录
• 文件大小限制：默认最大为 10MB
• URL 验证：仅允许 HTTP/HTTPS 协议
• 私有 IP 过滤：阻止访问内部网络
• 内容清理：移除可能有害的内容
• 请求超时：防止操作长时间运行

开发

项目结构

src/
├── engine/          # Conversion engine
├── security/        # Security validation
├── tools/           # MCP tool implementations
├── transports/      # Transport protocols
├── types/           # TypeScript type definitions
└── index.ts         # Main entry point

开发命令

npm run build        # Build project
npm run watch        # Watch mode build
npm run dev:stdio    # Development - stdio
npm run dev:http     # Development - HTTP

相关资源

Markdown 文档

• Markdown 完整指南 - 全面的 Markdown 语法教程，助你高效地将 md 转换为文本

在线工具

• MD 转文本转换器 - 免费的在线 Markdown 转文本工具，支持实时处理

许可证

MIT 许可证