内容
# 无标记MCP服务器
[](https://www.npmjs.com/package/@un-markdown/mcp-server)
[](https://github.com/UnMarkdown/mcp-server/blob/main/LICENSE)
[](https://smithery.ai/servers/unmarkdown/unmarkdown-mcp)
一个 [模型上下文协议](https://modelcontextprotocol.io) (MCP)服务器,连接AI助手到 [无标记](https://unmarkdown.com) API。转换markdown为精美格式的文档,管理您的文档库,并将页面发布到网络,所有这些都可以在Claude、Cursor、VS Code或任何MCP兼容的客户端中完成。
**也可用作:** [Chrome 扩展](https://chromewebstore.google.com/detail/unmarkdown/cfpkknmdjnkeelcdndkgmlmagekofhoa) | [网页应用](https://unmarkdown.com) | [REST API](https://docs.unmarkdown.com/api/overview)
## 功能
- **转换 markdown** 为样式化的HTML,支持8种目的地:Google Docs、Word、Slack、OneNote、Email、纯文本、通用HTML和原始HTML
- **62种视觉模板**,具有浅色和深色主题(Swiss、Executive、Terminal、GitHub等)
- **创建、读取、更新** 您在无标记库中的文档,组织成文件夹
- **发布文档** 到可共享的公共URL,格式为 `unmarkdown.com/d/您的slug`
- **跟踪API使用情况** 和当前计费周期的配额
## 安装
### 克劳德桌面版 / 克劳德 for macOS
将以下内容添加到您的克劳德桌面版配置文件中:
**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
```json
{
"mcpServers": {
"unmarkdown": {
"command": "npx",
"args": ["-y", "@un-markdown/mcp-server"],
"env": {
"UNMARKDOWN_API_KEY": "um_您的api密钥"
}
}
}
}
```
### 游标
将以下内容添加到您的游标MCP设置中(`.cursor/mcp.json`):
```json
{
"mcpServers": {
"unmarkdown": {
"command": "npx",
"args": ["-y", "@un-markdown/mcp-server"],
"env": {
"UNMARKDOWN_API_KEY": "um_您的api密钥"
}
}
}
}
```
### VS 代码
将以下内容添加到您的VS代码MCP设置中(`.vscode/mcp.json`):
```json
{
"servers": {
"unmarkdown": {
"command": "npx",
"args": ["-y", "@un-markdown/mcp-server"],
"env": {
"UNMARKDOWN_API_KEY": "um_您的api密钥"
}
}
}
}
```
### 全局安装
如果您更喜欢全局安装而不是使用 `npx`:
```bash
npm install -g @un-markdown/mcp-server
```
然后使用 `unmarkdown-mcp` 作为命令:
```json
{
"mcpServers": {
"unmarkdown": {
"command": "unmarkdown-mcp",
"env": {
"UNMARKDOWN_API_KEY": "um_您的api密钥"
}
}
}
}
```
## 配置
### 必需
| 变量 | 描述 |
| --- | --- |
| `UNMARKDOWN_API_KEY` | 您的无标记API密钥(以 `um_` 开头)。在您的无标记账户的 [设置 > API](https://unmarkdown.com) 中获取。 |
### 可选
| 变量 | 描述 | 默认值 |
| --- | --- | --- |
| `UNMARKDOWN_API_URL` | 自定义API基准URL | `https://api.unmarkdown.com` |
## 使用示例
### 示例1:转换会议笔记草稿为Google Docs
> “将此markdown转换为Google Docs,使用Executive模板:
>
> ```markdown
> # Q1 计划会议
>
> ## 参会者
> - Sarah Chen(产品)
> - Mike Torres(工程)
> - Lisa Park(设计)
>
> ## 行动项目
> - [ ] 在周五前完成路线图
> - [ ] 安排新仪表盘的设计审查
> - [ ] 更新利益相关者的演示文稿
> ```"
克劳德将使用 `convert_markdown` 工具,目标为 `"google-docs"`,模板ID为 `"executive"`,返回样式化的HTML,可以直接粘贴到Google Docs中,带有正确的标题、字体和颜色。
### 示例2:创建文件夹中的文档
> “在Release Notes文件夹中创建一个名为“API Changelog - February 2026”的新文档,包含以下内容,然后发布它。”
克劳德将:
1. 调用 `create_document`,包含标题、markdown内容和 `folder: "Release Notes"`
2. 调用 `publish_document`,包含返回的文档ID
文档直接在指定的文件夹中创建,您将获得一个类似 `https://unmarkdown.com/d/api-changelog-february-2026` 的实时URL。
### 示例3:更新和移动文档
> “将Q4报告移动到Archive文件夹并更新其标题。”
克劳德将:
1. 调用 `list_documents` 以查找文档
2. 调用 `update_document`,包含新标题和 `folder: "Archive"`
### 示例4:为Slack格式化markdown
> “将此项目更新转换为Slack格式,以便在团队频道中粘贴时看起来不错。”
克劳德使用 `convert_markdown`,目标为 `"slack"`,生成针对Slack渲染优化的输出(粗体、列表、代码块、表情符号支持)。
### 示例5:检查API使用情况
> “这个月我已经使用了多少API调用?”
克劳德调用 `get_usage` 并返回当前使用计数、每月限制和计费周期。
## 工具参考
| 工具 | 描述 | 只读 | 幂等 |
| --- | --- | --- | --- |
| `convert_markdown` | 将markdown转换为样式化的HTML,支持8种目的地 | 是 | 是 |
| `create_document` | 在您的库中创建新文档(可选在文件夹中) | 否 | 否 |
| `list_documents` | 列出保存的文档,支持分页(可选按文件夹过滤) | 是 | 是 |
| `get_document` | 通过ID获取文档,包含完整内容 | 是 | 是 |
| `update_document` | 修改文档的标题、内容、模板、元数据或文件夹 | 否 | 是 |
| `publish_document` | 将文档发布到可共享的公共URL | 否 | 是 |
| `get_usage` | 检查当前计费月的API配额 | 是 | 是 |
### 目的地
`convert_markdown` 工具支持以下输出格式:
| 目的地 | 描述 |
| --- | --- |
| `google-docs` | 优化为粘贴到Google Docs |
| `word` | 格式化为Microsoft Word |
| `slack` | Slack兼容格式化 |
| `onenote` | Microsoft OneNote兼容 |
| `email` | 适合电子邮件客户端的HTML |
| `plain-text` | 带有ASCII格式的纯文本 |
| `generic` | 通用样式化HTML |
| `html` | 原始HTML输出 |
### 模板
将任何模板ID传递给 `convert_markdown`、`create_document` 或 `update_document`。热门模板包括:
| 模板 | 类别 |
| --- | --- |
| `swiss` | 免费(默认) |
| `mono` | 免费 |
| `github` | 免费 |
| `terminal` | 免费 |
| `executive` | 商业(专业) |
| `consulting` | 商业(专业) |
| `startup` | 商业(专业) |
在 [unmarkdown.com/templates](https://unmarkdown.com/templates) 上浏览所有62种模板。
## API限制
| 计划 | 每月API调用 | 速率限制 |
| --- | --- | --- |
| 免费 | 1,000 | 10 req/sec |
| 专业版($8/mo 年付) | 10,000 | 30 req/sec |
超出额度:$1.00 每1,000额外调用(仅专业版)。免费计划有硬限制。
## 隐私
此MCP服务器将您的markdown内容和文档数据发送到无标记API(`api.unmarkdown.com`)进行处理。MCP服务器本身不会存储任何数据。所有数据处理都受 [无标记隐私政策](https://unmarkdown.com/privacy) 管辖。
具体来说:
- **Markdown内容** 通过 `convert_markdown` 发送,会立即被处理和返回。不会存储在无标记服务器上。
- **文档** 通过 `create_document` 或 `update_document` 创建,会存储在您的无标记账户中,可以随时删除。
- **API密钥** 验证请求,绝不会被记录或共享。
有关完整的隐私政策,请访问 [unmarkdown.com/privacy](https://unmarkdown.com/privacy)。
## 支持
- **问题:** [github.com/UnMarkdown/mcp-server/issues](https://github.com/UnMarkdown/mcp-server/issues)
- **文档:** [docs.unmarkdown.com](https://docs.unmarkdown.com)
- **API参考:** [docs.unmarkdown.com/api/overview](https://docs.unmarkdown.com/api/overview)
- **联系:** [unmarkdown.com/contact](https://unmarkdown.com/contact)
## 开发
```bash
# 克隆仓库
git clone https://github.com/UnMarkdown/mcp-server.git
cd mcp-server
# 安装依赖
npm install
# 构建
npm run build
# 本地运行(需要API密钥)
UNMARKDOWN_API_KEY=um_您的密钥 node build/index.js
```
## 另见
- **[Chrome 扩展](https://chromewebstore.google.com/detail/unmarkdown/cfpkknmdjnkeelcdndkgmlmagekofhoa)** — 在任何AI聊天页面(ChatGPT、Claude、Gemini)上检测和转换markdown
- **[网页应用](https://unmarkdown.com)** — 具有62种模板、发布、AI操作和分析的全功能编辑器
- **[REST API](https://docs.unmarkdown.com/api/overview)** — 以编程方式访问所有转换和文档功能
- **[Smithery](https://smithery.ai/servers/unmarkdown/unmarkdown-mcp)** — 通过Smithery MCP注册表安装
- **[npm](https://www.npmjs.com/package/@un-markdown/mcp-server)** — `@un-markdown/mcp-server` 在npm上
## 许可证
MIT。有关详细信息,请参见 [LICENSE](LICENSE)。