article
README
🚀 MariaDB/MySQL MCP 服务器
本项目是一个 MariaDB/MySQL MCP 服务器,可帮助用户便捷地进行数据库管理、表管理以及数据操作等功能。
🚀 快速开始
要使用 MariaDB/MySQL MCP 服务器,您可以按照以下步骤进行操作:
- 安装服务器。
- 进行相关配置。
- 启动服务器。
下面将为您详细介绍每个步骤。
📦 安装指南
1. 从 NPM 安装
您可以使用以下命令将 MariaDB/MySQL MCP 服务器安装到您的系统中:
npm install -g mariadb-mcp-server
2. 从源代码构建
如果您希望从源代码构建,请按照以下步骤操作:
- 克隆仓库:
git clone https://github.com/yourusername/mariaDB-mcp-server.git
cd mariaDB-mcp-server
- 安装依赖项:
npm install
- 构建项目:
npm run build
📚 详细文档
配置
环境变量配置
在运行服务器之前,请确保设置以下环境变量:
MARIADB_HOST:数据库主机地址,默认为localhost。MARIADB_PORT:数据库端口号,默认为3306。MARIADB_USER:数据库用户名。MARIADB_PASSWORD:数据库用户密码。
配置文件
您可以在项目的根目录下找到 config.json 文件,用于配置服务器的其他参数,例如:
{
"port": 3000,
"debug": false,
"logLevel": "info"
}
启动服务器
启动服务器的命令如下:
npm start
✨ 主要特性
1. 数据库管理
- 创建数据库:
CREATE DATABASE your_database;
- 删除数据库:
DROP DATABASE your_database;
- 使用数据库:
USE your_database;
2. 表管理
- 创建表:
CREATE TABLE users (
id INT AUTO_INCREMENT PRIMARY KEY,
username VARCHAR(50) NOT NULL,
email VARCHAR(100) NOT NULL UNIQUE
);
- 删除表:
DROP TABLE users;
3. 数据操作
- 插入数据:
INSERT INTO users (username, email) VALUES ('john', 'john@example.com');
- 查询数据:
SELECT * FROM users WHERE id = 1;
- 更新数据:
UPDATE users SET username = 'johndoe' WHERE id = 1;
- 删除数据:
DELETE FROM users WHERE id = 1;
💻 使用示例
创建用户表并插入数据
CREATE TABLE users (
id INT AUTO_INCREMENT PRIMARY KEY,
username VARCHAR(50) NOT NULL,
email VARCHAR(100) NOT NULL UNIQUE
);
INSERT INTO users (username, email) VALUES ('alice', 'alice@example.com');
查询用户表中的所有数据
SELECT * FROM users;
🔧 技术细节
错误处理
常见错误及解决方案
- 连接超时
- 检查数据库服务是否正在运行。
- 确保防火墙没有阻止端口
3306。
- 权限不足
- 确保数据库用户拥有足够的权限。
- 使用以下命令授予权限:
GRANT ALL PRIVILEGES ON *.* TO 'your_user'@'localhost' IDENTIFIED BY 'your_password';
FLUSH PRIVILEGES;
- 语法错误
- 检查 SQL 语句的语法是否正确。
- 使用数据库管理工具验证查询。
📄 许可证
本项目基于 Lucas 的 MySQL MCP 服务器 开发,更多信息请参考以下参考文献:
扫码联系在线客服