内容
# url-to-markdown
[中文文档](docs/README.zh-CN.md)
一款从 URL 地址提取网页内容并将其转换为干净的 Markdown 格式的 MCP 服务器。
## 功能特点
- 使用 Mozilla Readability 从任何 URL 地址提取可读内容
- 通过 Turndown 将 HTML 转换为干净的 Markdown 格式
- 内置重试逻辑,处理暂时的失败
- SSRF 防护阻止对私有网络的访问
- 当 Readability 失败时自动回落到其他提取方式
## 安装
```bash
pnpm install
pnpm build
```
## 使用
### 与 Claude Desktop 结合使用
添加到您的 Claude MCP 配置中:
```json
{
"mcpServers": {
"url-to-markdown": {
"command": "node",
"args": ["/path/to/url-to-markdown/build/index.js"]
}
}
}
```
### 工具:`extract`
从 URL 地址提取内容并返回 Markdown 格式。
**参数:**
- `url`(字符串,必填):要提取内容的 URL 地址(必须以 `http://` 或 `https://` 开头)
**返回:** Markdown 内容或错误信息。
### 工具:`search`
搜索微信公众号文章。
**参数:**
- `query`(字符串,必填):搜索关键词
- `page`(数字,可选):页码,默认为 1
**返回:** 搜索结果列表或错误信息。
## 开发
| 命令 | 描述 |
|---------|-------------|
| `pnpm dev` | 监视模式 |
| `pnpm test` | 运行测试 |
| `pnpm build` | 构建 |
| `pnpm lint` | 检查代码规范 |
| `pnpm format` | 格式化代码 |
## 贡献
请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 获取指南。
## 许可证
本项目使用 [GNU Lesser General Public License v2.1](LICENSE) 许可证。