Markdown to HTML MCP Server 使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现，它提供了一个 'markdown_to_html' 工具，可以将 Markdown 格式的文本转换为 HTML 格式。这个服务器可以与支持 MCP 协议的客户端（如 Claude Desktop）配合使用，让 LLM 能够调用此工具进行 Markdown 转换。

主要功能点

Markdown to HTML 转换工具: 提供 'markdown_to_html' 工具，接收 Markdown 文本作为输入，返回转换后的 HTML 文本。
MCP 服务器: 遵循 MCP 协议，可以被 MCP 客户端发现和调用。
支持标准输入输出 (stdio) 传输: 使用 stdio 作为 MCP 服务器的传输协议。

安装步骤

安装 Node.js 和 npm: 确保你的系统已经安装了 Node.js 和 npm。
克隆仓库: 将仓库 'https://github.com/fashionzzZ/markdown-to-html' 克隆到本地。
安装依赖: 在仓库根目录下运行 'npm install' 命令安装项目依赖。
构建项目: 运行 'npm run build' 命令构建项目，生成可执行的 JavaScript 文件。

服务器配置

要将此 MCP 服务器添加到 MCP 客户端（例如 Claude Desktop），你需要配置服务器信息。以下是配置示例，你需要根据你的实际安装路径进行调整。

假设你将仓库克隆到 '/path/to/markdown-to-html' 目录。

{
  "mcpServers": {
    "markdown-to-html": {
      "command": "node",
      "args": [
        "/path/to/markdown-to-html/build/index.js"  //  指向构建后的服务器入口文件
      ]
    }
  }
}

配置说明:

'server name': 服务器名称，这里设置为 'markdown-to-html'，可以自定义。
'command': 启动服务器的命令，这里使用 'node' 运行 JavaScript 文件。
'args': 命令参数，指向服务器入口文件 'build/index.js' 的绝对路径。请根据你的实际路径修改 '/path/to/markdown-to-html'。

将以上配置添加到 MCP 客户端的配置文件中。例如，对于 Claude Desktop：

MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

基本使用方法

启动 MCP 服务器: 配置完成后，MCP 客户端会自动启动该 MCP 服务器。
在 MCP 客户端中使用: 在支持 MCP 协议的客户端中，你可以指示 LLM 调用 'markdown_to_html' 工具，并将 Markdown 文本作为 'mdContent' 参数传递给工具。服务器会将 Markdown 转换为 HTML 并返回给客户端。

例如，在 Claude 中，你可以这样指示：

使用 markdown_to_html 工具将以下 Markdown 文本转换为 HTML: '''# Hello World'''

服务器会将 "# Hello World" 转换为 "<h1>Hello World</h1>" 并返回。

关键词