esa MCP Server

공식

esa.io를 위한 공식 Model Context Protocol (MCP) 서버 - STDIO 전송 버전입니다.

Esa MCP(으)로 무엇을 할 수 있나요?

  • 게시물 검색 및 읽기 — esa_search_posts로 게시물을 찾은 다음, 번호로 특정 게시물을 가져와 esa_get_post로 백링크 수와 본문 통계를 확인합니다.
  • 콘텐츠 작성 및 수정 — esa_create_post로 게시물을 작성하고, esa_update_post로 수정하거나 esa_append_post 및 esa_prepend_post로 텍스트를 뒤에 추가하거나 앞에 삽입합니다.
  • 게시물 수명 주기 관리 — esa_ship_post로 게시물을 공개하고, esa_archive_post로 보관하거나, esa_duplicate_post로 복제하거나, 이전 버전으로 되돌립니다.
  • 댓글 관리 — 게시물이나 팀의 댓글을 나열한 다음, esa_create_comment, esa_update_comment, esa_delete_comment로 댓글을 작성, 수정 또는 삭제합니다.
  • 카테고리 및 팀 탐색 — esa_get_all_category_paths로 카테고리 경로를 살펴보고, esa_get_team_stats 및 esa_get_team_members로 팀 세부 정보를 확인합니다.
  • 게시물 요약 — esa_summarize_post 프롬프트를 사용해 특정 팀 게시물의 구조화된 요약을 생성합니다.

문서

esa MCP Server

License: MIT

日本語 | English

esa.io용 공식 Model Context Protocol (MCP) 서버 - STDIO 전송 버전입니다.

개요

이 MCP 서버는 협업 문서 플랫폼인 esa.io와 AI 어시스턴트 간의 원활한 통합을 제공합니다. AI 어시스턴트가 Model Context Protocol을 통해 esa 문서를 직접 읽고, 만들고, 업데이트하고 관리할 수 있습니다.

사용 가능한 도구

팀 관리

  • esa_get_teams - 사용자가 액세스할 수 있는 esa 팀 가져오기
  • esa_get_team_stats - 팀 통계 가져오기(멤버, 게시물, 댓글, 별표, 구독, 활성 사용자)
  • esa_get_team_tags - 팀 게시물에서 사용된 모든 태그와 개수 가져오기
  • esa_get_team_members - 역할 및 프로필 정보가 포함된 팀 멤버 가져오기

게시물 관리

  • esa_search_posts - esa.io에서 게시물 검색
  • esa_get_post - 게시물 번호로 특정 게시물 가져오기(본문의 문자 수와 줄 수가 포함된 backlinks_count 및 body_md_stats 포함)
  • esa_get_post_backlinks - 페이지네이션을 사용해 특정 게시물을 참조하는 게시물 목록 가져오기
  • esa_create_post - 태그, 카테고리, WIP 상태를 지정해 새 게시물 만들기
  • esa_update_post - 기존 게시물 업데이트(제목, 내용, 태그, 카테고리, WIP 상태)
  • esa_append_post - 게시물 본문 끝에 내용 추가(현재 본문을 가져올 필요 없음, 새 리비전으로 저장)
  • esa_prepend_post - 게시물 본문 시작 부분에 내용 추가(현재 본문을 가져올 필요 없음, 새 리비전으로 저장)

게시물 작업

  • esa_archive_post - 게시물을 Archived/ 카테고리로 이동해 보관
  • esa_ship_post - 게시물을 완료로 표시(wip를 false로 설정)
  • esa_duplicate_post - 게시물 복제(같은 제목과 본문으로 새 WIP 게시물 만들기, 팀 간 복제도 지원)
  • esa_rollback_post_revision - 게시물을 지정된 리비전으로 롤백(복원된 내용은 새 리비전으로 저장됨. esa_get_post에서 revision_number을 통해 리비전 번호 확인)

댓글 관리

  • esa_get_comment - ID로 특정 댓글 가져오기
  • esa_create_comment - 게시물에 새 댓글 작성
  • esa_update_comment - 기존 댓글 업데이트
  • esa_delete_comment - 댓글 삭제
  • esa_get_post_comments - 페이지네이션을 사용해 특정 게시물의 댓글 가져오기
  • esa_get_team_comments - 페이지네이션을 사용해 팀 댓글 가져오기

카테고리 관리

  • esa_get_categories - 특정 경로의 카테고리 및 하위 카테고리 가져오기
  • esa_get_top_categories - 팀의 최상위 카테고리 모두 가져오기
  • esa_get_all_category_paths - 팀의 모든 카테고리 경로 가져오기(게시물 수 포함, 필터링 지원)
    • 카테고리 구조 파악, 구성 계획 수립, 정리에 적합
    • 필터 예시: 개발 관련 카테고리는 prefix: "dev", API 관련 카테고리는 match: "api"

첨부 파일

  • esa_get_attachment - esa 게시물 및 댓글의 첨부 파일 가져오기
    • 30MB 미만의 지원 이미지(JPEG, PNG, GIF, WebP)는 base64 인코딩 데이터로 반환
    • 그 외 파일 형식, 더 큰 이미지 또는 forceSignedUrl이 지정된 경우 서명된 URL(유효 기간 5분) 반환

도움말 및 문서

  • esa_get_search_options_help - esa 검색 구문 문서 가져오기
  • esa_get_markdown_syntax_help - esa Markdown 구문 문서 가져오기
  • esa_search_help - 기능 및 용어에 관한 esa 문서 검색

사용 가능한 리소스

  • esa_recent_posts - esa 팀에서 최근 업데이트된 게시물 가져오기
    • 템플릿: esa://teams/{teamName}/posts/recent
    • 반환값: 최근 업데이트된 게시물의 JSON 목록

사용 가능한 프롬프트

  • esa_summarize_post - esa 게시물 내용 요약
    • 입력: 팀 이름 및 게시물 번호
    • 출력: 게시물 내용의 구조화된 요약

MCP 클라이언트 구성

MCP 클라이언트 구성 파일에 추가하세요.

필수 환경 변수

  • ESA_ACCESS_TOKEN: 액세스 토큰
    • 필수 범위: read write 또는 admin:comment read:post write:post read:category read:tag read:attachment read:team read:member
    • PAT v2를 권장합니다.
  • LANG: UI 언어

Claude Desktop 예시

claude_desktop_config.json에 추가하세요.

옵션 1: Docker(권장)

{
  "mcpServers": {
    "esa": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ESA_ACCESS_TOKEN",
        "-e",
        "LANG",
        "ghcr.io/esaio/esa-mcp-server"
      ],
      "env": {
        "ESA_ACCESS_TOKEN": "your_personal_access_token",
        "LANG": "en"
      }
    }
  }
}

옵션 2: npx

{
  "mcpServers": {
    "esa": {
      "command": "/Users/your-username/.nodenv/shims/npx",
      "args": ["@esaio/esa-mcp-server"],
      "env": {
        "ESA_ACCESS_TOKEN": "your_personal_access_token",
        "LANG": "en"
      }
    }
  }
}

참고: /path/to/your/node을 which node 명령의 출력으로 바꾸세요.

레지스트리

이 패키지는 패키지 루트에 registry.json을 포함하며, 등록된 도구, 리소스, 프롬프트를 제공합니다. 서버를 실행하지 않고도 프로그래밍 방식으로 사용할 수 있습니다.

import registry from "@esaio/esa-mcp-server/registry.json" with {
  type: "json",
};

스키마:

{
  "tools": [{ "name": "esa_get_teams" }, "..."],
  "resources": [
    {
      "name": "esa_recent_posts",
      "uriTemplate": "esa://teams/{teamName}/posts/recent"
    }
  ],
  "prompts": [{ "name": "esa_summarize_post" }]
}

이 파일은 npm run build:registry에서 다시 생성되며, CI 검사를 통해 등록된 항목과 동기화된 상태인지 확인합니다.

링크

지원


esa 팀이 ❤️를 담아 만들었습니다.