MCP 服务器文档

安装指南

使用 Smithery 安装

若使用 Smithery 进行安装，请运行以下命令：

smithery install @benborla/mcp-server-mysql

使用 MCP Get 安装

若使用 MCP Get 进行安装，请运行以下命令：

mcp-get install @benborla/mcp-server-mysql

快速入门指南

1. 启动服务器：

   • 使用 Smithery 启动：

     smithery start @benborla/mcp-server-mysql
     

   • 使用 MCP Get 启动：

     mcp-get start @benborla/mcp-server-mysql
     

2. 连接到服务器： 参考MCP 客户端文档了解如何连接。

详细配置指南

环境变量配置

创建并运行以下命令以设置环境变量：

export MCP_SERVER_NAME=@benborla/mcp-server-mysql

配置参考

以下是服务器的配置选项：

客户端使用示例

Node.js 示例代码

const mcp = require('@benborla/mcp-client');

async function main() {
    const server = new mcp.Server('@benborla/mcp-server-mysql');
    
    try {
        await server.connect();
        console.log('连接成功!');
        
        // 查询示例
        const query = 'SELECT * FROM users';
        const result = await server.query(query);
        console.log(result);
    } catch (error) {
        console.error('发生错误:', error.message);
    }
}

main();

服务器日志

查看日志

• 使用 Smithery 查看日志：

  smithery logs @benborla/mcp-server-mysql
  

• 使用 MCP Get 查看日志：

  mcp-get logs @benborla/mcp-server-mysql
  

高级功能

增强的查询能力

支持预处理语句以提升性能和安全性。

安全特性

包括限流、黑白名单机制及 SSL/TLS 加密配置，确保数据传输安全。

性能优化

通过调整连接池大小和查询超时设置来优化服务器性能。

监控与扩展

扩展信息

项目持续开发中，更多功能请关注CHANGELOG.md。

故障排除

典型问题

1. 连接问题：

   • 确认 MySQL 服务运行且可访问。
   • 检查凭据和权限设置。
   • 验证 SSL/TLS 配置，若启用。

2. 性能问题：

   • 调整连接池大小。
   • 设置合适的查询超时值。
   • 启用查询缓存。

贡献指南

如何贡献

• 查看CONTRIBUTING.md获取详细信息。

开发设置

本地开发

git clone git@github.com:benborla/mcp-server-mysql.git
cd mcp-server-mysql
npm install

运行测试

npm test

许可证

项目遵循 MIT 协议，具体条款参见LICENSE。

联系方式

• 邮箱：contact@benborla.com
• GitHub：github.com/benborla/mcp-server-mysql

感谢使用 MCP 服务器！如需帮助，请随时联系。