HackMD MCP Server

by yuna0x0
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Provides access to the HackMD API, enabling note management capabilities including creating, reading, updating, and deleting notes, viewing read history, and working with team notes on the HackMD collaborative markdown platform.

HackMD MCP サーバー

これは、HackMD APIとやり取りするためのモデルコンテキストプロトコル(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 Server を自動的にインストールするには:

npx -y @smithery/cli install @yuna0x0/hackmd-mcp --client claude # For other MCP clients, use the following command: # List available clients npx -y @smithery/cli list clients # Install to other clients npx -y @smithery/cli install @yuna0x0/hackmd-mcp --client <client_name>

mcp-get 経由でインストールする

npx @michaellatman/mcp-get@latest install hackmd-mcp

手動インストール

  1. このサーバーをclaude_desktop_config.jsonに追加します。
{ "mcpServers": { "hackmd": { "command": "npx", "args": ["-y", "hackmd-mcp"], "env": { "HACKMD_API_TOKEN": "your_api_token" } } } }
  1. Claudeデスクトップを再起動します
  2. 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 : チーム内のノートを削除する

使用例

Can you help me manage my HackMD notes?

次に、次のようなコマンドを使用します。

Please list all my notes.

地域開発

このプロジェクトではパッケージマネージャーとしてBunを使用しています。まだインストールしていない場合はインストールしてください。

リポジトリをクローンし、依存関係をインストールします。

git clone https://github.com/yuna0x0/hackmd-mcp.git cd hackmd-mcp bun install

構成

  1. 次の例をコピーして.envファイルを作成します。
cp .env.example .env
  1. .envファイルを編集し、HackMD API トークンを追加します。
HACKMD_API_TOKEN=your_api_token

MCP Inspectorによるデバッグ

MCP Inspector を使用して HackMD MCP サーバーをテストおよびデバッグできます。

npx @modelcontextprotocol/inspector -e HACKMD_API_TOKEN=your_api_token npx hackmd-mcp # Use this instead when Local Development bun run inspector

次に、ブラウザで指定されたURL(通常はhttp://localhost:5173 )を開き、MCP Inspectorインターフェースにアクセスします。そこから以下の操作が可能です。

  1. 実行中のHackMD MCPサーバーに接続します
  2. 利用可能なツールを参照する
  3. カスタムパラメータでツールを実行する
  4. 回答を見る

これは、Claude または他の AI アシスタントに接続する前にセットアップをテストする場合に特に便利です。

ドッカー

Docker Hub からプル:

docker pull yuna0x0/hackmd-mcp

Docker ビルド (ローカル開発):

docker build -t yuna0x0/hackmd-mcp .

Docker マルチプラットフォーム ビルド (ローカル開発):

docker buildx build --platform linux/amd64,linux/arm64 -t yuna0x0/hackmd-mcp .

セキュリティに関するお知らせ

このMCPサーバーでは、HackMD APIトークンを.envファイルまたは環境変数として保存する必要があります。この情報は安全に保管し、バージョン管理にコミットしないでください。

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています - 詳細についてはLICENSEファイルを参照してください。

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

AI アシスタントが HackMD API と対話してメモの管理(メモの作成、読み取り、更新、削除など)を行えるようにするモデル コンテキスト プロトコル サーバー。

  1. Requirements
    1. Environment Variables
      1. Install to Claude Desktop (or other MCP clients)
        1. Installing via Smithery
        2. Installing via mcp-get
        3. Manual Installation
      2. Available Tools
        1. User API
        2. User Notes API
        3. Teams API
        4. Team Notes API
      3. Example Usage
        1. Local Development
          1. Configuration
        2. Debugging with MCP Inspector
          1. Docker
            1. Security Notice
              1. License
                ID: 2lnhpu8zmr