yytest
这是一个用于与HackMD API交互的模型上下文协议（MCP）服务器，允许AI助手执行诸如获取用户信息、列出用户的笔记、创建、读取、更新和删除笔记、查看阅读历史以及处理团队笔记等操作。
MCP 服务配置
复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用
{
"mcpServers": {
"hackmd": {
"args": [
"-y",
"hackmd-mcp"
],
"command": "npx",
"env": {
"HACKMD_API_TOKEN": "your_api_token"
}
}
}
}该服务需要配置环境变量：HACKMD_API_TOKEN、dsfas
可用工具 （12 个）
该服务在 MCP 协议中暴露的工具，AI 可按需调用
get_user_info
Get information about the authenticated user
该工具无需必填参数，直接调用即可
list_user_notes
List all notes owned by the user
该工具无需必填参数，直接调用即可
get_note 1 个参数 需填 1 项
Get a note by its ID
必填参数：noteId
create_note 1 个参数 需填 1 项
Create a new note
必填参数：payload
update_note 2 个参数 需填 2 项
Update an existing note
必填参数：noteId、payload
delete_note 1 个参数 需填 1 项
Delete a note
必填参数：noteId
get_history
Get user's reading history
该工具无需必填参数，直接调用即可
list_teams
List all teams accessible to the user
该工具无需必填参数，直接调用即可
list_team_notes 1 个参数 需填 1 项
List all notes in a team
必填参数：teamPath
create_team_note 2 个参数 需填 2 项
Create a new note in a team
必填参数：teamPath、payload
update_team_note 3 个参数 需填 3 项
Update an existing note in a team
必填参数：teamPath、noteId、options
delete_team_note 2 个参数 需填 2 项
Delete a note in a team
必填参数：teamPath、noteId
服务介绍
HackMD MCP 服务器
这是一个用于与 HackMD API 交互的 Model Context Protocol (MCP) 服务器。它允许 AI 助手执行以下操作：
- 获取用户信息
- 列出用户的笔记
- 创建、读取、更新和删除笔记
- 查看阅读历史
- 处理团队笔记
系统要求
- Node.js 18+
环境变量
HACKMD_API_TOKEN: [必需] 您的 HackMD API 令牌HACKMD_API_URL: (可选) HackMD API 端点 URL。默认值:https://api.hackmd.io/v1
您可以在 HackMD 设置 中获取 API 令牌。
安装到 Claude Desktop（或其他 MCP 客户端）
通过 Smithery 安装
要通过 Smithery 自动为 Claude Desktop 安装 HackMD MCP 服务器，请运行以下命令：
bash
npx -y @smithery/cli install @yuna0x0/hackmd-mcp --client claude
对于其他 MCP 客户端，使用以下命令：
列出可用客户端
npx -y @smithery/cli list clients
安装到其他客户端
npx -y @smithery/cli install @yuna0x0/hackmd-mcp --client <client_name>
通过 mcp-get 安装
bash
npx @michaellatman/mcp-get@latest install hackmd-mcp
手动安装
- 将此服务器添加到您的
claude_desktop_config.json文件中：
json
{
"mcpServers": {
"hackmd": {
"command": "npx",
"args": ["-y", "hackmd-mcp"],
"env": {
"HACKMD_API_TOKEN": "your_api_token"
}
}
}
}
- 重启 Claude Desktop
- 使用工具与您的 HackMD 账户进行交互
可用工具
用户 API
- get_user_info: 获取已认证用户的信息
用户笔记 API
- list_user_notes: 列出用户拥有的所有笔记
- get_note: 根据 ID 获取笔记
- create_note: 创建新笔记
- update_note: 更新现有笔记
- delete_note: 删除笔记
- get_history: 获取用户的阅读历史
团队 API
- list_teams: 列出用户可以访问的所有团队
团队笔记 API
- list_team_notes: 列出团队中的所有笔记
- create_team_note: 在团队中创建新笔记
- update_team_note: 更新团队中的现有笔记
- delete_team_note: 删除团队中的笔记
示例用法
你能帮我管理我的 HackMD 笔记吗？
然后使用如下命令：
请列出我所有的笔记。
本地开发
该项目使用 pnpm 作为其包管理器。
克隆仓库并安装依赖项：
bash
git clone https://github.com/yuna0x0/hackmd-mcp.git
cd hackmd-mcp
pnpm install
配置
-
通过复制示例文件来创建
.env文件：
bash
cp .env.example .env -
编辑
.env文件并添加您的 HackMD API 令牌：
HACKMD_API_TOKEN=your_api_token
使用 MCP Inspector 进行调试
您可以使用 MCP Inspector 来测试和调试 HackMD MCP 服务器：
bash
npx @modelcontextprotocol/inspector -e HACKMD_API_TOKEN=your_api_token npx hackmd-mcp
本地开发时使用以下命令
pnpm run inspector
然后在浏览器中打开提供的 URL（通常是 http://127.0.0.1:6274）以访问 MCP Inspector 界面。在那里，您可以：
- 连接到正在运行的 HackMD MCP 服务器
- 浏览可用工具
- 使用自定义参数运行工具
- 查看响应
这在将设置连接到 Claude 或其他 AI 助手之前特别有用。
Docker
从 Docker Hub 拉取镜像：
bash
docker pull yuna0x0/hackmd-mcp
Docker 构建（本地开发）：
bash
docker build -t yuna0x0/hackmd-mcp .
多平台 Docker 构建（本地开发）：
bash
docker buildx build --platform linux/amd64,linux/arm64 -t yuna0x0/hackmd-mcp .
安全通知这台MCP服务器需要你在.env文件中或作为环境变量提供HackMD API令牌。请确保此信息的安全，切勿将其提交到版本控制系统。
许可证
本项目采用MIT许可证进行授权 - 详情请参阅LICENSE文件。
