VRChat MCP Server

일본어 | 한국어

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

개요

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

용법

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

지엑스피1

[!메모]

AUTH TOKEN을 얻는 방법

다음 명령을 사용하여 로그인하고 인증 토큰을 얻을 수 있습니다.

$ npx vrchat-auth-token-checker VRChat Username: your-username Password: ******** # If 2FA is enabled 2FA Code: 123456 # Success output Auth Token: authcookie-xxxxx

명령 소스 코드

획득한 토큰은 매우 긴 수명을 가지고 있으므로 주의해서 다루시기 바랍니다.

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

이렇게 하면 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 관련 도구를 제공합니다.

사용자 관련

• vrchat_get_friends_list: 친구 목록을 가져옵니다
• vrchat_send_friend_request: 친구 요청 보내기

아바타 관련

• vrchat_search_avatars: 아바타 검색
• vrchat_select_avatar: 특정 아바타를 선택하고 전환합니다.

세계 관련

• vrchat_search_worlds: 세계 검색
• vrchat_list_favorited_worlds: 즐겨찾는 세계 목록을 가져옵니다.

인스턴스 관련

• vrchat_create_instance: 새 인스턴스를 만듭니다
• vrchat_get_instance: 특정 인스턴스에 대한 정보를 가져옵니다.

그룹 관련

• vrchat_search_groups: 그룹 검색
• vrchat_join_group: 그룹에 가입하세요

즐겨찾기 관련

• vrchat_list_favorites: 즐겨찾기 목록을 가져옵니다
• vrchat_add_favorite: 새로운 즐겨찾기 추가
• vrchat_list_favorite_groups: 즐겨찾는 그룹 목록을 가져옵니다.

관련 초대

• vrchat_list_invite_messages: 초대 메시지 목록을 가져옵니다.
• vrchat_request_invite: 초대 요청
• vrchat_get_invite_message: 특정 초대 메시지를 받습니다.

알림 관련

• vrchat_get_notifications: 알림 목록을 가져옵니다

디버깅

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

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

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

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

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

출판

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

1. 메인 브랜치에서 최신 코드를 가져옵니다.
   git checkout main git pull origin main
2. 패키지 빌드
   npm run build
3. npm에 게시
   npm publish
4. 원격 저장소에 변경 사항 푸시
   git push origin main --tags

기여하다

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

특허

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