mcp-client-server-markdown: A Markdown MCP client and server

mcp-client-server-markdown: A Markdown MCP client and server

site icon
2025.04.21 0
TypeScript文档管理内容生成开发效率内容生成开发效率
mcp-client-server-markdown 是一个基于 Model Context Protocol (MCP) 的服务器应用,提供 Markdown 文档的创建、编辑、搜索、转换为 HTML 和管理功能。该项目结合了讯飞星火大模型 API 和 MCP 协议,实现了智能化的 Markdown 文档处理能力。
View on GitHub

Overview

基本能力

产品定位

mcp-client-server-markdown 是一个基于 MCP 协议的 Markdown 文档处理服务器,专注于提供智能化的文档管理和转换功能。

核心功能

  1. Markdown 文档管理
  2. 创建文档:通过自然语言指令创建新的 Markdown 文档
  3. 编辑文档:修改现有文档内容
  4. 删除文档:安全删除不再需要的文档
  5. 搜索文档:全文搜索文档内容

  6. 文档转换

  7. Markdown 转 HTML:将 Markdown 内容转换为 HTML 格式

  8. 智能模板

  9. 提供多种 Markdown 模板(文章、笔记、待办事项、会议记录等)
  10. 自动生成文档摘要

  11. 对话式交互

  12. 通过自然语言与系统交互
  13. 支持工具调用和上下文记忆

适用场景

  1. 个人笔记管理:快速创建和编辑个人笔记
  2. 团队协作:使用模板创建会议记录或项目计划
  3. 文档转换:将 Markdown 转换为 HTML 用于网页发布
  4. 内容生成:利用 AI 能力自动生成文档内容

工具列表

  1. client.ts:MCP 客户端实现
  2. server.ts:MCP 服务器实现
  3. markdowns/:Markdown 文档存储目录

常见问题解答

  1. 如何获取星火 API 密钥?
  2. 需要联系讯飞获取 SPARK_API_KEY, SPARK_API_SECRET, SPARK_APP_ID
  3. 如何配置环境变量?
  4. 创建 .env 文件并按照示例配置环境变量

使用教程

使用依赖

  1. 安装 Node.js (v16+) bash # 在 Ubuntu 上安装 Node.js sudo apt update sudo apt install nodejs sudo apt install npm

  2. 获取星火 API 密钥 (SPARK_API_KEY, SPARK_API_SECRET, SPARK_APP_ID)

  3. 创建 .env 文件并配置环境变量 bash # 示例 .env 文件内容 SPARK_API_KEY=your_api_key SPARK_API_SECRET=your_api_secret SPARK_APP_ID=your_app_id

安装教程

  1. 克隆仓库: bash git clone https://github.com/your-repo/mcp-markdown-server.git cd mcp-markdown-server

  2. 安装依赖: bash npm install

  3. 启动服务器: bash node server.js

  4. 启动客户端: bash node client.js server.js

调试方式

  1. 检查服务器是否运行: bash ps aux | grep node

  2. 检查端口是否监听: bash netstat -tulnp | grep node

  3. 查看日志: bash tail -f server.log

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。