XiYan MCP 서버

특징

🌐 XiYanSQL 을 통해 자연어로 데이터 가져오기
🤖 일반 LLM(GPT, qwenmax), Text-to-SQL SOTA 모델 지원
💻 순수 로컬 모드 지원(높은 보안성!)
📝 MySQL과 PostgreSQL을 지원합니다.
🖱️ 사용 가능한 테이블을 리소스로 나열합니다.
🔧 표 내용 읽기

시사

건축학

이 서버를 프로젝트에 통합하는 방법은 아래와 같이 두 가지가 있습니다. 왼쪽은 기본 모드인 원격 모드입니다. 서비스 제공업체에서 xiyanSQL-qwencoder-32B 모델에 액세스하려면 API 키가 필요합니다( 구성 참조). 또 다른 모드는 보안성이 더 높은 로컬 모드입니다. API 키가 필요하지 않습니다.

건축.png

모범 사례 및 보고서

"코드 한 줄도 작성하지 않고 MCP + Modelscope API-Inference를 사용하여 로컬 데이터 어시스턴트를 구축하세요"

"모델스코프의 Xiyan MCP"

MCPBench에서의 평가

다음 그림은 MCPBench 벤치마크를 통해 측정된 XiYan MCP 서버의 성능을 보여줍니다. XiYan MCP 서버는 MySQL MCP 서버와 PostgreSQL MCP 서버보다 2~22%p 높은 성능을 보였습니다. 자세한 실험 결과는 MCPBench 와 "MCP 서버 평가 보고서" 에서 확인할 수 있습니다.

$exp\_mcpbench.png$

도구 미리보기

get_data 도구는 데이터베이스에서 데이터를 검색하기 위한 자연어 인터페이스를 제공합니다. 이 서버는 내장 모델을 사용하여 입력된 자연어를 SQL로 변환하고, 데이터베이스를 호출하여 쿼리 결과를 반환합니다.
{dialect}://{table_name} 리소스를 사용하면 특정 table_name이 지정될 때 모델 참조를 위해 데이터베이스에서 샘플 데이터의 일부를 얻을 수 있습니다.
{dialect}:// 리소스는 현재 데이터베이스의 이름을 나열합니다.

설치

pip에서 설치

Python 3.11 이상이 필요합니다. pip를 통해 서버를 설치하면 최신 버전이 설치됩니다.

지엑스피1

소스에서 개발 버전을 설치하려면 github의 소스 코드에서 설치할 수 있습니다.

pip install git+https://github.com/XGenerationLab/xiyan_mcp_server.git

Smithery.ai에서 설치

@XGenerationLab/xiyan_mcp_server를 참조하세요.

아직 완전히 테스트되지 않았습니다.

구성

서버를 구성하려면 YAML 구성 파일이 필요합니다. 기본 구성 파일은 config_demo.yml에 다음과 같이 제공됩니다.

mcp:
  transport: "stdio"
model:
  name: "XGenerationLab/XiYanSQL-QwenCoder-32B-2412"
  key: ""
  url: "https://api-inference.modelscope.cn/v1/"
database:
  host: "localhost"
  port: 3306
  user: "root"
  password: ""
  database: ""

MCP 구성

전송 프로토콜을 stdio 또는 sse 로 설정할 수 있습니다.

스튜디오

stdio 프로토콜의 경우 다음과 같이 설정할 수 있습니다.

mcp:
  transport: "stdio"

남남동

SSE 프로토콜의 경우 아래와 같이 mcp 구성을 설정할 수 있습니다.

mcp:
  transport: "sse"
  port: 8000
  log_level: "INFO"

기본 포트는 8000 입니다. 필요한 경우 포트를 변경할 수 있습니다. 기본 로그 수준은 ERROR 입니다. 더 자세한 정보를 보려면 로그 수준을 INFO 로 설정하는 것이 좋습니다.

debug , host , sse_path , message_path 와 같은 다른 구성도 사용자 정의가 가능하지만 일반적으로 이를 수정할 필요는 없습니다.

LLM 구성

Name 사용할 모델의 이름이고, key 모델의 API 키이며, url 모델의 API URL입니다. 다음 모델을 지원합니다.

버전	일반 LLM(GPT, qwenmax)	Modelscope의 SOTA 모델	Dashscope의 SOTA 모델	지역 LLM
설명	기본적이고 사용하기 쉬움	최고의 성능, 안정성, 추천	최고의 성능, 시험용	느리고 보안이 엄격함
이름	공식 모델명(예: gpt-3.5-turbo, qwen-max)	XGenerationLab/XiYanSQL-QwenCoder-32B-2412	xiyansql-qwencoder-32b	xiyansql-qwencoder-3b
열쇠	서비스 제공자(예: OpenAI, Alibaba Cloud)의 API 키	모델스코프의 API 키	이메일을 통한 API 키	""
URL	서비스 제공자의 엔드포인트(예: " https://api.openai.com/v1 ")	https://api-inference.modelscope.cn/v1/	https://xiyan-stream.biz.aliyun.com/service/api/xiyan-sql	http://localhost:5090

일반 LLM

일반 LLM(예: gpt3.5)을 사용하려면 다음과 같이 직접 구성할 수 있습니다.

model:
  name: "gpt-3.5-turbo"
  key: "YOUR KEY "
  url: "https://api.openai.com/v1"
database:

Alibaba의 Qwen(예: Qwen-max)을 사용하려면 다음 구성을 사용할 수 있습니다.

model:
  name: "qwen-max"
  key: "YOUR KEY "
  url: "https://dashscope.aliyuncs.com/compatible-mode/v1"
database:

텍스트-SQL SOTA 모델

XiYanSQL-qwencoder-32B( https://github.com/XGenerationLab/XiYanSQL-QwenCoder )를 권장합니다. 이는 텍스트-SQL 변환의 SOTA 모델입니다. Bird 벤치마크를 참조하세요. 이 모델을 사용하는 방법은 두 가지가 있습니다. (1) Modelscope , (2) Alibaba Cloud DashScope 중 하나를 사용할 수 있습니다.

(1) 모델스코프 버전

Modelscope에서 API-inference key 적용해야 합니다. https://www.modelscope.cn/docs/model-service/API-Inference/intro 그런 다음 다음 구성을 사용할 수 있습니다.

model:
  name: "XGenerationLab/XiYanSQL-QwenCoder-32B-2412"
  key: ""
  url: "https://api-inference.modelscope.cn/v1/"

자세한 내용은 모델 설명을 읽어보세요.

(2) 대시스코프 버전

Alibaba Cloud DashScope에 모델을 배포했으므로 다음 환경 변수를 설정해야 합니다. key 받으려면 이메일을 보내주세요. ( godot.lzl@alibaba-inc.com ) 이메일에 다음 정보를 첨부해 주세요.

name: "YOUR NAME",
email: "YOUR EMAIL",
organization: "your college or Company or Organization"

이메일로 key 보내드리겠습니다. yml 파일에 key 입력하시면 됩니다. key 1개월 또는 200회 쿼리, 또는 기타 법적 제한 사항이 있을 경우 만료됩니다.

model:
  name: "xiyansql-qwencoder-32b"
  key: "KEY"
  url: "https://xiyan-stream.biz.aliyun.com/service/api/xiyan-sql"

참고: 이 모델 서비스는 체험용일 뿐입니다. 실제 운영에 사용하려면 저희에게 문의하세요.

(3) 로컬 버전

또는 XiYanSQL-qwencoder-32B 모델을 자체 서버에 배포할 수도 있습니다. 자세한 내용은 로컬 모델을 참조하세요.

데이터베이스 구성

host , port , user , password , database 데이터베이스의 연결 정보입니다.

로컬 또는 원격 데이터베이스를 사용할 수 있습니다. 이제 MySQL과 PostgreSQL을 지원합니다(곧 더 많은 언어 지원 예정).

MySQL

database:
  host: "localhost"
  port: 3306
  user: "root"
  password: ""
  database: ""

포스트그레스큐엘

1단계: Python 패키지 설치

pip install psycopg2

2단계: 다음과 같이 config.yml을 준비합니다.

database:
  dialect: "postgresql"
  host: "localhost"
  port: 5432
  user: ""
  password: ""
  database: ""

postgresql의 경우 dialect postgresql 이어야 합니다.

시작하다

서버 출시

sse 로 서버를 시작하려면 터미널에서 다음 명령을 실행해야 합니다.

YML=path/to/yml python -m xiyan_mcp_server

그러면 브라우저에서 http://localhost:8000/sse 정보를 볼 수 있습니다. (기본적으로 mcp 서버가 다른 호스트/포트에서 실행되는 경우 변경하세요.)

stdio 전송 프로토콜을 사용하는 경우, 일반적으로 터미널에서 실행하는 대신 특정 mcp 애플리케이션에서 mcp server 명령을 선언합니다. 하지만 필요한 경우 이 명령으로 디버깅할 수 있습니다.

클라이언트 설정

클로드 데스크탑

Claude Desktop 구성 파일에 이것을 추가하세요. Claude Desktop 구성 예시를 참조하세요.

{
    "mcpServers": {
        "xiyan-mcp-server": {
            "command": "/xxx/python",
            "args": [
                "-m",
                "xiyan_mcp_server"
            ],
            "env": {
                "YML": "PATH/TO/YML"
            }
        }
    }
}

여기서 Python 명령을 실행하려면 Python 실행 파일( /xxx/python )의 전체 경로가 필요합니다. 그렇지 않으면 Python 인터프리터를 찾을 수 없습니다. which python 명령을 사용하여 이 경로를 확인할 수 있습니다. 다른 애플리케이션에도 동일하게 적용됩니다.

Claude Desktop은 현재 SSE 전송 프로토콜을 지원하지 않습니다.

클라인

Claude Desktop과 같은 구성을 준비하세요

거위

stdio 사용하는 경우 다음 명령을 config에 추가하세요. Goose config 예제를 참조하세요.

env YML=path/to/yml /xxx/python -m xiyan_mcp_server

그렇지 않은 경우 sse 사용하는 경우 유형을 SSE 로 변경하고 엔드포인트를 http://127.0.0.1:8000/sse 로 설정합니다.

커서

다음과 같이 비슷한 명령을 사용합니다.

stdio 의 경우:

{
  "mcpServers": {
    "xiyan-mcp-server": {
      "command": "/xxx/python",
      "args": [
        "-m",
        "xiyan_mcp_server"
      ],
      "env": {
        "YML": "path/to/yml"
      }
    }
  }
}

sse 의 경우:

{
  "mcpServers": {
    "xiyan_mcp_server_1": {
      "url": "http://localhost:8000/sse"
    }
  }
}

위트시

명령에 다음을 추가합니다.

/xxx/python -m xiyan_mcp_server

env를 추가합니다. 키는 YML이고 값은 YML 파일 경로입니다. Witsy 구성 예시를 참조하세요.

작동하지 않습니다!

연락처: Ding Group钉钉群 | 웨이보에서 나를 팔로우하세요.

기타 관련 링크

소환

만약 저희의 자료가 도움이 된다면, 꼭 인용해 주시기 바랍니다.

@article{xiyansql,
      title={A Preview of XiYan-SQL: A Multi-Generator Ensemble Framework for Text-to-SQL}, 
      author={Yingqi Gao and Yifu Liu and Xiaoxia Li and Xiaorong Shi and Yin Zhu and Yiming Wang and Shiqi Li and Wei Li and Yuntao Hong and Zhiling Luo and Jinyang Gao and Liyu Mou and Yu Li},
      year={2024},
      journal={arXiv preprint arXiv:2411.08599},
      url={https://arxiv.org/abs/2411.08599},
      primaryClass={cs.AI}
}

This server cannot be installed

security - not tested

license - permissive license

quality - not tested

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

XiYanSQL 텍스트-SQL 기술을 기반으로 MySQL 데이터베이스에 대한 자연어 쿼리를 가능하게 하는 모델 컨텍스트 프로토콜 서버입니다.

Related Resources

Reddit Discussion about this server

Related MCP Servers

MySQL-MCP
zajTools
-
security
F
license
-
quality
A Model Context Protocol server that enables SQL query execution, database management, and business intelligence capabilities through MySQL connections.
Last updated -
JavaScript
MCP MySQL Server
Atomzzm
-
security
-
license
-
quality
A Model Context Protocol server that enables AI models to interact with MySQL databases, providing tools for querying, executing statements, listing tables, and describing table structures.
Last updated -
MIT License
MCP MySQL Server
kevinbin
-
security
-
license
-
quality
A Model Context Protocol server that enables AI models to interact with MySQL databases through a standardized interface, providing tools for querying, executing commands, and managing database schemas.
Last updated -
JavaScript
MySQL MCP Server
caicongyang
-
security
F
license
-
quality
A Model Context Protocol server that enables AI models to interact with MySQL databases through natural language, supporting SQL queries, table creation, and schema exploration.
Last updated -
1
Python

View all related MCP servers

목차

특징

시사

건축학