使用说明
项目简介
FastAPI MCP Server 是一个使用 FastAPI 框架构建的 MCP (Model Context Protocol) 服务器。它旨在为 AI 助手(如 Claude)提供统一的接口,使其能够安全、便捷地访问各种工具和数据源。通过实现 MCP 协议,该服务器充当 AI 助手与外部资源之间的桥梁,提升 AI 应用的功能性和灵活性。
主要功能点
- 统一接口: 为 AI 助手提供标准化的 JSON-RPC 接口,用于访问各种工具和数据源,简化集成流程。
- 工具管理: 允许注册和管理各种工具,AI 助手可以通过服务器调用这些工具执行特定任务。
- 数据访问: 支持托管和管理数据资源,AI 助手可以请求访问这些资源获取上下文信息。
- Prompt 模板: 支持定义和渲染 Prompt 模板,方便定制与 AI 助手的交互模式。
- 易于部署: 基于 FastAPI 框架,易于安装和部署,可以使用标准的 Python 工具链进行管理。
安装步骤
-
克隆仓库
git clone https://github.com/NishizukaKoichi/fastapi-mcp-server.git cd fastapi-mcp-server -
创建并激活虚拟环境
python3 -m venv venv source venv/bin/activate # Linux/macOS venv\Scripts\activate # Windows -
安装依赖
pip install fastapi uvicorn
服务器配置
MCP 服务器需要配置到 MCP 客户端中才能使用,例如 Claude Desktop。以下是配置示例,你需要将这段 JSON 配置添加到 Claude Desktop 的配置文件 ('claude_desktop_config.json') 中,以连接到 FastAPI MCP Server。
{ "mcpServers": { "fastapi-mcp": { // 服务器名称,可以自定义 "command": "python", // 启动服务器的命令,这里使用 python "args": [ // 启动服务器的参数列表 "-m", // 以模块方式运行 "fastapi_mcp_server" // 运行 fastapi_mcp_server 模块,即启动服务器 ] } } }
配置说明:
- '"fastapi-mcp"': 是你为这个 MCP 服务器自定义的名称,在 Claude Desktop 中用于标识和选择该服务器。
- '"command": "python"': 指定用于启动服务器的命令为 'python'。你需要确保你的系统环境中 'python' 命令指向 Python 3.6 或更高版本。
- '"args": [...]"': 是一个字符串数组,包含了启动服务器的详细参数。
- '"-m"': Python 的 '-m' 参数表示以模块名来运行 Python 模块。
- '"fastapi_mcp_server"': 指定要运行的模块名为 'fastapi_mcp_server',这会执行 'fastapi_mcp_server/main.py' 文件或者 'fastapi_mcp_server/init.py' 中定义的模块入口点(如果配置了)。根据仓库结构,这里应该是启动 FastAPI 应用的入口。
注意: 你需要根据你的实际环境调整 'command' 和 'args',例如,如果你的 Python 可执行文件路径不是直接在 PATH 环境变量中,你需要提供完整的路径。
基本使用方法
-
启动服务器 在终端中,进入 'fastapi-mcp-server' 仓库目录,并确保虚拟环境已激活,运行以下命令启动服务器:
uvicorn fastapi_mcp_server:app --reload- 'uvicorn': 是一个 ASGI 服务器,用于运行 FastAPI 应用。
- 'fastapi_mcp_server:app': 指定 FastAPI 应用的入口点。'fastapi_mcp_server' 是 Python 模块名,'app' 是在 'fastapi_mcp_server' 模块中创建的 FastAPI 应用实例。
- '--reload': 开启热重载模式,方便开发调试,修改代码后服务器会自动重启。
-
查看 API 文档 服务器启动后,打开浏览器访问 http://localhost:8000/docs 可以查看自动生成的 Swagger API 文档。你可以通过这个文档了解服务器提供的具体 API 接口和功能。
-
配置 MCP 客户端 按照 服务器配置 章节的说明,将生成的 JSON 配置添加到你的 MCP 客户端(如 Claude Desktop)的配置文件中。
-
连接和使用 重启 MCP 客户端,客户端应该能够检测到并连接到 FastAPI MCP Server。之后,你就可以在 MCP 客户端中使用服务器提供的工具和数据访问功能了。具体的工具和功能使用方式,需要参考 FastAPI MCP Server 项目本身的代码和 API 文档。
信息
分类
网页与API