VRChat MCP Server

일본어 | 한국어

이 프로젝트는 VRChat API와 상호 작용하기 위한 모델 컨텍스트 프로토콜(MCP) 서버입니다. 표준화된 프로토콜을 사용하여 VRChat에서 다양한 정보를 가져올 수 있습니다.

개요

VRChat MCP 서버는 VRChat API 엔드포인트에 체계적으로 접근할 수 있는 방법을 제공합니다. 사용자 인증, 사용자 및 친구 정보 검색, 아바타 및 월드 데이터 접근 등 다양한 기능을 지원합니다.

용법

서버를 시작하려면 필요한 환경 변수가 설정되어 있는지 확인하세요.

지엑스피1

[!메모]

TOTP 비밀번호를 얻으세요

1. VRChat 프로필을 방문하여 2단계 인증을 활성화하세요.
2. 표시된 QR 코드를 디코딩하여 otpauth://totp/VRChat:your@email.com?secret=XXXXXXXXXXXXXXXXXXX&issuer=VRChat 와 같은 문자열을 얻습니다.
3. TOTP 비밀번호로 XXXXXXXXXXXXXXXXXXX 부분을 사용하세요.

이 방법에는 보안 문제가 있을 수 있으므로 주의해서 사용하세요.

그런 다음 다음 명령을 실행합니다.

이렇게 하면 MCP 서버가 실행되어 정의된 도구를 통해 VRChat API와 상호 작용할 수 있습니다.

Claude Desktop과 함께 사용

이 MCP 서버를 Claude Desktop에서 사용하려면 npx vrchat-mcp 수동으로 실행할 필요가 없습니다. 대신 Claude Desktop 설정 파일에 다음 구성을 추가하세요.

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

그런 다음 평소처럼 Claude Desktop을 시작합니다. nodenv나 nvm을 사용해야 하는 경우 npx 명령의 전체 경로를 지정해야 할 수 있습니다.

VRChat API 엔드포인트

이는 모델 컨텍스트 프로토콜 서버가 지원하거나 지원할 예정인 VRChat API의 엔드포인트 목록입니다. 포괄적인 기능을 제공하기 위해 GET 및 POST 메서드가 모두 포함되어 있습니다. 체크박스는 각 엔드포인트의 구현 상태를 나타냅니다.

인증 및 사용자 정보

• [x] 현재 사용자 정보 가져오기
• [ ] 사용자 검색
• [ ] 특정 사용자 프로필 가져오기
• [ ] 사용자 그룹 가져오기
• [ ] 플레이어 조정 받기
• [ ] 사용자 상태 가져오기
• [ ] 사용자 정보 업데이트
• [ ] 사용자 상태 업데이트
• [ ] 사용자 차단
• [ ] 사용자 차단 해제

친구 관련

• [x] 친구 목록 가져오기
• [ ] 온라인 친구 얻기
• [x] 친구 요청 보내기
• [ ] 친구요청 수락/거부
• [ ] 친구삭제

아바타 관련

• [ ] 나만의 아바타를 얻으세요
• [ ] 좋아하는 아바타를 얻으세요
• [x] 아바타 검색
• [ ] 특정 아바타 세부 정보 가져오기
• [ ] 공개 아바타 가져오기
• [ ] 아바타 만들기
• [ ] 아바타 업데이트
• [ ] 아바타 삭제
• [x] 아바타 선택
• [ ] 즐겨찾기/즐겨찾지 않음 아바타

세계 관련

• [ ] 세계 목록 가져오기
• [ ] 활동적인 세계를 얻으세요
• [ ] 최근 방문한 세계 가져오기
• [ ] 좋아하는 세계를 얻으세요
• [x] 세계 검색
• [ ] 특정 세계 세부 정보 얻기
• [ ] 월드 인스턴스 가져오기
• [ ] 공개 세계를 얻으세요
• [ ] 세상을 창조하다
• [ ] 세계 업데이트
• [ ] 세계 삭제
• [ ] 좋아하는/싫어하는 세계

인스턴스 관련

• [x] 인스턴스 생성
• [x] 인스턴스 정보 가져오기
• [ ] 인스턴스 참석자 가져오기
• [ ] 인스턴스 약어 가져오기
• [ ] 인스턴스 조인
• [ ] 인스턴스를 종료합니다
• [ ] 사용자를 인스턴스에 초대합니다.

파일 관련

• [ ] 파일 정보 가져오기
• [ ] 파일 다운로드 정보 받기
• [ ] 파일 상태 가져오기

그룹 관련

• [x] 그룹 검색
• [ ] 특정 그룹 정보 가져오기
• [ ] 그룹 멤버 얻기
• [ ] 그룹 권한 얻기
• [ ] 그룹 요청 받기
• [ ] 그룹 초대 받기
• [ ] 그룹 금지 받기
• [ ] 그룹 갤러리 가져오기
• [ ] 그룹 소유의 세계를 얻으세요
• [ ] 그룹 생성
• [ ] 그룹 업데이트
• [ ] 그룹 삭제
• [x] 그룹 가입
• [ ] 그룹 탈퇴
• [ ] 사용자를 그룹에 초대합니다
• [ ] 그룹 초대 수락/거부
• [ ] 그룹에서 사용자 금지
• [ ] 그룹에서 사용자 금지 해제

알림 관련

• [ ] 알림 목록 가져오기
• [ ] 친구 요청 받기
• [ ] 읽지 않은 알림 개수 가져오기
• [ ] 알림을 읽음으로 표시
• [ ] 알림 삭제
• [ ] 모든 알림 지우기

재고 관련

• [ ] 라이센스 유형 가져오기
• [ ] 자체 라이센스 받기
• [ ] 매장 목록 가져오기

시스템 관련

• [ ] API 구성 가져오기
• [ ] API 제한 가져오기
• [ ] 시스템 상태 확인
• [ ] 온라인 사용자 수를 구하세요
• [ ] 서버 공지사항 받기

즐겨찾기

• [x] 즐겨찾기 목록
• [x] 즐겨찾기 추가
• [ ] 즐겨찾기 삭제
• [x] 즐겨찾는 그룹 목록
• [ ] 즐겨찾는 그룹 표시
• [ ] 즐겨찾는 그룹 업데이트
• [ ] 즐겨찾는 그룹 지우기
• [ ] 즐겨찾는 제한 가져오기

초대합니다

• [x] 초대 메시지 목록
• [x] 초대 요청
• [ ] 초대장 보내기
• [x] 초대 메시지 받기
• [ ] 초대 메시지 업데이트

기타

• [ ] 태그 목록 가져오기
• [ ] 보이지 않는 목록 가져오기
• [ ] 조정을 받으세요
• [ ] 즐겨찾는 그룹 유형을 가져옵니다
• [ ] 조정을 생성하세요
• [ ] 조정 삭제

디버깅

먼저 프로젝트를 빌드합니다.

MCP 서버는 stdio를 통해 실행되므로 디버깅이 어려울 수 있습니다. 최상의 디버깅 환경을 위해서는 MCP Inspector 사용을 강력히 권장합니다.

다음 명령을 사용하여 npm을 통해 MCP Inspector를 시작할 수 있습니다.

환경 변수가 올바르게 구성되었는지 확인하세요.

Inspector를 실행하면 브라우저에서 접근하여 디버깅을 시작할 수 있는 URL이 표시됩니다.

출판

패키지의 새 버전을 게시하려면 다음 단계를 따르세요.

1. 메인 브랜치에서 최신 코드를 가져옵니다.
   git checkout main git pull origin main
2. 필요에 따라 버전을 업데이트하세요
   # For patch version updates (e.g., 0.1.2 → 0.1.3) npm version patch # For minor version updates (e.g., 0.1.2 → 0.2.0) npm version minor # For major version updates (e.g., 0.1.2 → 1.0.0) npm version major
3. 패키지 빌드
   npm run build
4. npm에 게시
   npm publish
5. 원격 저장소에 변경 사항 푸시
   git push origin main --tags

기여하다

기여를 환영합니다! 개선 사항이나 버그 수정 사항이 있으면 저장소를 포크하고 풀 리퀘스트를 제출해 주세요.

특허

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