MCP 연동 가이드
ERDify MCP 서버를 AI 도구에 연결하면, AI와 함께 스키마를 읽고 수정하고 DDL을 생성할 수 있습니다.
MCP란?
MCP(Model Context Protocol)는 AI 도구와 외부 서비스를 연결하는 오픈 표준입니다. ERDify MCP 서버를 설치하면 Cursor, Claude Desktop 같은 AI 도구가 ERDify의 스키마를 직접 읽고 수정할 수 있습니다.
어떻게 동작하나요?
AI 도구 → MCP 서버 → ERDify API 순서로 통신합니다. AI가 "orders 테이블 추가해줘"라고 요청받으면, MCP 서버가 ERDify API를 호출해 실제 ERD를 수정합니다.
사전 준비
- Node.js 18 이상 설치
- ERDify API 키 (앱 → 설정 → API에서 발급)
- 지원 AI 도구 중 하나: Cursor, Claude Desktop, Gemini CLI, Codex CLI
도구별 설정
프로젝트 루트 또는 ~/.cursor/에 mcp.json 파일을 생성하거나 수정하세요.
{
"mcpServers": {
"erdify": {
"command": "npx",
"args": ["-y", "@erdify/mcp-server@latest"],
"env": {
"ERDIFY_API_KEY": "erd_your_api_key_here"
}
}
}
} 저장 후 Cursor를 재시작하면 AI Chat에서 ERDify MCP를 사용할 수 있습니다.
Claude Desktop 설정 파일을 열어 아래 내용을 추가하세요.
{
"mcpServers": {
"erdify": {
"command": "npx",
"args": ["-y", "@erdify/mcp-server@latest"],
"env": {
"ERDIFY_API_KEY": "erd_your_api_key_here"
}
}
}
} 저장 후 Claude Desktop을 완전히 종료하고 재시작하세요.
~/.gemini/settings.json 파일에 아래 내용을 추가하세요.
{
"mcpServers": {
"erdify": {
"command": "npx",
"args": ["-y", "@erdify/mcp-server@latest"],
"env": {
"ERDIFY_API_KEY": "erd_your_api_key_here"
}
}
}
} 설정 후 gemini CLI를 재실행하면 ERDify 도구가 활성화됩니다.
~/.codex/config.yaml 파일에 아래 내용을 추가하세요.
mcp_servers:
erdify:
command: npx
args:
- -y
- "@erdify/mcp-server@latest"
env:
ERDIFY_API_KEY: erd_your_api_key_here 저장 후 codex CLI를 재실행하세요.
사용 가능한 MCP 도구
연결된 AI 도구에서 아래 기능을 자연어로 요청할 수 있습니다.
| 도구 이름 | 설명 | 예시 요청 |
|---|---|---|
list_projects | 프로젝트 목록 조회 | "내 ERDify 프로젝트 목록 보여줘" |
get_schema | 현재 ERD 전체 스키마 조회 | "현재 ERD 테이블 구조 알려줘" |
get_entity | 특정 테이블 상세 조회 | "users 테이블 컬럼 목록 보여줘" |
add_entity | 새 테이블 추가 | "orders 테이블 추가해줘" |
update_entity | 테이블·컬럼 수정 | "users 테이블에 phone_number 컬럼 추가해줘" |
delete_entity | 테이블 삭제 | "temp_logs 테이블 삭제해줘" |
add_relationship | 테이블 간 관계 설정 | "orders와 users 사이에 FK 관계 만들어줘" |
export_ddl | DDL 생성 및 반환 | "PostgreSQL DDL로 내보내줘" |
연결 확인
설정 완료 후 AI 도구에서 아래 메시지를 입력해 연결을 확인하세요.
현재 ERDify 프로젝트의 테이블 목록을 보여줘
ERDify MCP가 정상 연결됐다면 현재 ERD의 테이블 목록이 반환됩니다.