Skip to content

API.md

Latest commit

 

History

History
282 lines (184 loc) · 6.18 KB

API.md

File metadata and controls

282 lines (184 loc) · 6.18 KB

API 문서

Project Bot의 8개 MCP 도구 상세 명세입니다.

create_project

프로젝트 카테고리와 채널을 일괄 생성합니다.

파라미터

이름 타입 필수 설명
project_name string O 프로젝트명
teams string X 커스텀 팀명 (쉼표 구분)

동작

  • teams 미지정: 기본 5개 팀(기획, 프론트엔드, 백엔드, 인프라, 공통) 생성
  • teams 지정: 지정된 팀만 커스텀 채널(💬-{팀명}-일반, 🐛-{팀명}-이슈)로 생성

반환값

프로젝트 'my-app' 생성 완료
카테고리 5개, 채널 15개 생성됨
카테고리: my-app / 기획, my-app / 프론트엔드, ...

사용 예시

create_project(project_name="my-app")
create_project(project_name="my-app", teams="QA, 디자인")

add_team

기존 프로젝트에 새로운 팀 카테고리를 추가합니다.

파라미터

이름 타입 필수 설명
project_name string O 프로젝트명
team_name string O 추가할 팀명

동작

  • 기본 템플릿에 있는 팀명이면 해당 채널 구조 적용
  • 그 외 팀명이면 커스텀 채널 2개 생성

반환값

팀 'QA' 추가 완료 (프로젝트: my-app)
카테고리: my-app / QA
채널 2개 생성됨

에러

  • 프로젝트가 없으면: 프로젝트 'xxx'를 찾을 수 없습니다
  • 팀이 이미 존재하면: 팀 'xxx'이(가) 이미 존재합니다

사용 예시

add_team(project_name="my-app", team_name="QA")
add_team(project_name="my-app", team_name="기획")

add_channel

특정 팀에 채널을 추가합니다.

파라미터

이름 타입 필수 설명
project_name string O 프로젝트명
team_name string O 팀명
channel_name string O 생성할 채널명

반환값

채널 '📋-자주묻는질문' 생성 완료
위치: my-app / 프론트엔드

에러

  • 카테고리가 없으면: 카테고리 'xxx'를 찾을 수 없습니다
  • 채널이 이미 존재하면: 채널 'xxx'이(가) 이미 존재합니다

사용 예시

add_channel(project_name="my-app", team_name="프론트엔드", channel_name="📋-자주묻는질문")

delete_project

프로젝트의 모든 카테고리와 채널을 삭제합니다.

파라미터

이름 타입 필수 설명
project_name string O 삭제할 프로젝트명

반환값

프로젝트 'my-app' 삭제 완료
카테고리 5개, 채널 15개 삭제됨

에러

  • 프로젝트가 없으면: 프로젝트 'xxx'를 찾을 수 없습니다

주의사항

  • 삭제된 카테고리와 채널은 복구할 수 없습니다
  • 채널 내 모든 메시지도 함께 삭제됩니다

사용 예시

delete_project(project_name="my-app")

list_projects

등록된 모든 프로젝트 목록을 조회합니다.

파라미터

없음

반환값

JSON 형식으로 프로젝트별 팀 목록 반환:

{
  "my-app": ["기획", "프론트엔드", "백엔드", "인프라", "공통"],
  "other-app": ["공통", "QA"]
}

프로젝트가 없으면: 등록된 프로젝트가 없습니다

사용 예시

list_projects()

send_notification

프로젝트의 claude-알림 채널에 Embed 형식 알림을 전송합니다.

파라미터

이름 타입 필수 설명
project_name string O 프로젝트명
message string O 알림 메시지
event_type string O 알림 타입

event_type

값 설명 색상
plan 플랜 작성 파란색 (0x3498DB)
question 질문 제시 주황색 (0xE67E22)
complete 작업 완료 초록색 (0x2ECC71)
error 에러 발생 빨간색 (0xE74C3C)
build 빌드 진행 보라색 (0x9B59B6)
test 테스트 진행 노란색 (0xF1C40F)
deploy 배포 진행 분홍색 (0xE91E63)

반환값

알림 전송 완료 [작업 완료] → 🤖-claude-알림

에러

  • claude-알림 채널이 없으면: claude-알림 채널을 찾을 수 없습니다
  • 잘못된 event_type: 알 수 없는 event_type: xxx

사용 예시

send_notification(project_name="my-app", message="로그인 기능 구현 완료", event_type="complete")
send_notification(project_name="my-app", message="빌드 실패", event_type="error")

send_message

특정 채널에 일반 메시지를 전송합니다.

파라미터

이름 타입 필수 설명
project_name string O 프로젝트명
channel_keyword string O 채널 검색 키워드
content string O 메시지 내용

동작

프로젝트 카테고리 내에서 channel_keyword를 포함하는 첫 번째 채널을 찾아 메시지를 전송합니다.

반환값

메시지 전송 완료 → 💬-자유톡

에러

  • 채널을 찾을 수 없으면: '{keyword}' 채널을 찾을 수 없습니다

사용 예시

send_message(project_name="my-app", channel_keyword="자유톡", content="안녕하세요!")
send_message(project_name="my-app", channel_keyword="프론트-일반", content="PR 리뷰 부탁드립니다")

read_messages

특정 채널의 최근 메시지를 읽어옵니다.

파라미터

이름 타입 필수 기본값 설명
project_name string O - 프로젝트명
channel_keyword string O - 채널 검색 키워드
limit integer X 10 조회할 메시지 수

반환값

[2026-02-28 14:00] Alice: 첫 번째 메시지
[2026-02-28 14:05] Bob: 두 번째 메시지

메시지가 없으면: 메시지가 없습니다

에러

  • 채널을 찾을 수 없으면: '{keyword}' 채널을 찾을 수 없습니다

사용 예시

read_messages(project_name="my-app", channel_keyword="자유톡")
read_messages(project_name="my-app", channel_keyword="claude-알림", limit=5)