A Template MCP Server

A Template MCP Server

site icon
2025.04.30 0
Python数据库管理AI 代理集成数据库
agents-mcp-demo 是一个基于 MCP(Model Context Protocol)标准的模板服务器,旨在展示如何构建、配置和运行一个基本的 MCP 服务器。该服务器通过 PostgreSQL 数据库后端管理用户数据,作为 AI 代理与外部数据源之间的安全网关。核心功能包括定义和暴露自定义工具、处理 MCP 客户端的请求、将请求转换为后端资源操作(如数据库查询)以及返回结构化结果或错误。
View on GitHub

Overview

基本能力

产品定位

agents-mcp-demo 是一个演示性质的 MCP 服务器模板,用于连接 AI 代理和服务(如 Claude)与工具和数据源。

核心功能

  • 定义和暴露自定义工具(如 add_user, get_all_users, find_user_by_email, delete_user_by_email)。
  • 处理 MCP 客户端的请求。
  • 将请求转换为后端资源操作(如数据库查询)。
  • 返回结构化结果或错误。

适用场景

  • AI 代理与数据库交互的演示场景。
  • 学习如何构建 MCP 服务器的示例。
  • 测试 MCP 协议的基本功能。

工具列表

  • add_user: 添加新用户到数据库。
  • get_all_users: 检索所有用户的列表。
  • find_user_by_email: 通过电子邮件查找特定用户。
  • delete_user_by_email: 根据电子邮件删除用户。

常见问题解答

  • 无具体常见问题解答内容。

使用教程

使用依赖

  • Python 3.10+
  • PostgreSQL 数据库访问权限。
  • Docker(推荐用于轻松运行服务器)。
  • uv(用于本地开发依赖管理)。

安装教程

使用 Docker(推荐)

  1. 构建镜像: bash docker build -t sql-mcp-demo-server --build-arg PORT=${DB_PORT:-8051} .
  2. 运行容器: bash docker run --rm -d --env-file .env -p ${DB_PORT:-8051}:${DB_PORT:-8051} --name sql-mcp-server sql-mcp-demo-server

本地开发

  1. 安装依赖: bash python -m venv .venv source .venv/bin/activate # or .\.venv\Scripts\activate on Windows uv pip install -e .[dev]
  2. 设置环境变量: 确保 DB_URL 在 shell 环境或 .env 文件中设置。
  3. 运行服务器: bash uv run python sqlmcp/server.py

调试方式

  • 使用 Ruff 进行代码检查和格式化: bash uv run ruff check . uv run ruff format .
  • 使用 Pytest 进行测试(测试尚未实现)。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。