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 비서가 다음과 같은 작업을 수행할 수 있도록 지원합니다.

  • 사용자 정보 가져오기
  • 사용자 메모 목록
  • 메모 생성, 읽기, 업데이트 및 삭제
  • 읽은 기록 보기
  • 팀 노트 작업

요구 사항

  • 노드.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 서버를 자동으로 설치하려면:

지엑스피1

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 Desktop을 다시 시작하세요
  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 서버는 .env 파일이나 환경 변수로 HackMD API 토큰을 필요로 합니다. 이 정보를 안전하게 보관하고 버전 관리 시스템에 커밋하지 마세요.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여되었습니다. 자세한 내용은 라이선스 파일을 참조하세요.

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