F5 MCP

F5 MCP服务器

F5设备（TMOS/BIG-IP） iControl REST API连接到 模型上下文协议（MCP）服务器是。\ 可以设置为自然语言请求，包括虚拟服务器、池、配置文件、首选项、L4标准设置、HA。

连接信息：mgmt IP、帐户、密码不存储在文件中。调用所有工具时 tmos_host, tmos_用户名, tmos_密码 输入作为参数。

______________________________________________________________________

目录

1. 项目结构
2. 文档（.md）指南
3. 部署和安装指南
4. 开发指南和指南

______________________________________________________________________

1.项目结构

f5-mcp/
├── F5MCPserver.py          # MCP 서버 진입점. 도구 정의 및 stdio 트랜스포트
├── Tools/
│   ├── F5object.py         # F5 iControl REST API 클라이언트 (CRUD, 기본설정, L4 표준, HA 등)
│   └── settings.py         # 연결 설정 생성 (build_endpoint_settings). 저장소/파일 없음
├── scripts/
│   ├── run_mcp.bat         # Windows용 MCP 실행 (프로젝트 루트에서 python -m F5MCPserver)
│   ├── run_mcp.sh         # macOS/Linux용 MCP 실행
│   └── commit-if-changes.sh # 변경 시 커밋 헬퍼 (선택)
├── explore_configs.py      # DNS/NTP/Syslog 등 조회 스크립트 (CLI 인자로 host/계정 전달)
├── requirements.txt        # Python 의존성 (requests, mcp, python-dotenv, PyYAML)
├── claude_desktop_config.json
├── claude_desktop_config.windows.example.json
├── claude_desktop_config.mac.example.json
└── *.md                    # 가이드 문서: guide_*, prompt_* (아래 §2 참고)

• 实际动作: F5MCPserver.py定义MCP工具，每个工具 _resolve_connection(tmos_host, …)验证连接后 Tools.F5object.F5_object使用进行API调用。
• 连接信息: .env不使用或设备列表文件。每次呼叫 tmos_host, tmos_username, tmos_password（和选择 tmos_port）。

______________________________________________________________________

2.文档（.md）指南

名称规则： 导游\_ =使用•设置指南， 提示\_ =AI规则。

部署和安装本README的 §3部署和安装指南，开发时要参考的规则是 §4开发指南和指南在中整理。

______________________________________________________________________

3.部署和安装指南

在Windows和macOS上安装、运行和Claude的联动方法。

3.1前提条件

• Python3.7或更高版本

- 窗户： python.org在安装时 “将Python添加到PATH” 选择 - macOS： python3 或者Homebrew等

• F5连接信息：管理IP、帐户（例如admin）、密码（每次调用工具时都输入）

3.2项目准备

代码位置

REM Windows
cd C:\Users\사용자명\경로\f5-mcp

# macOS
cd /Users/사용자명/경로/f5-mcp

虚拟环境（可选）

REM Windows
python -m venv .venv
.venv\Scripts\activate

# macOS
python3 -m venv .venv
source .venv/bin/activate

依赖性安装

REM Windows
pip install -r requirements.txt

# macOS
pip install -r requirements.txt

3.3连接信息

连接信息包括： 不写入文件或.env。\ Claude等每次使用MCP工具时 tmos_host（管理IP）、 tmos_用户名, tmos_密码 作为参数。 tmos_port（默认443）是可选的。

3.4执行方法

在终端上确认

• 窗户： python -m F5MCPserver 或 scripts\run_mcp.bat
• macOS： python3 -m F5MCPserver 或 ./scripts/run_mcp.sh （需要时 chmod +x scripts/run_mcp.sh)

在Claude Desktop中用作MCP

1. 设置文件位置

- 视窗:\ %APPDATA%\Claude\claude_desktop_config.json\ 池路径： C:\Users\사용자명\AppData\Roaming\Claude\claude_desktop_config.json - 如果文件夹/文件不存在: C:\Users\사용자명\AppData\Roaming\ 下面 Claude 创建文件夹，并在其中 claude_desktop_config.json 创建文件即可。 - Microsoft Store（MSIX）安装版如果使用，应用实际读取的路径可能为：\ C:\Users\사용자명\AppData\Local\Packages\Claude_xxxxx\LocalCache\Roaming\Claude\claude_desktop_config.json\ （在Packages下的文件夹名称中 Claude查找并使用包含的。如果MCP不起作用，请将配置文件放在该路径上进行修改。） - macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

1. 设置示例（Windows） — command在run_mcp.bat 绝对路径

{
  "mcpServers": {
    "f5-mcp": {
      "command": "C:\\Users\\사용자명\\경로\\f5-mcp\\scripts\\run_mcp.bat",
      "args": [],
      "env": {}
    }
  }
}

1. 设置示例（MacOS） — command在run_mcp.sh 绝对路径

{
  "mcpServers": {
    "f5-mcp": {
      "command": "/Users/사용자명/경로/f5-mcp/scripts/run_mcp.sh",
      "args": [],
      "env": {}
    }
  }
}

1. 保存设置后 Claude Desktop完全关闭 →重新运行→ 新建聊天在中使用F5工具

设置示例文件： claude_desktop_config.windows.example.json, claude_desktop_config.mac.example.json （仅实际更改路径使用）。

Mac/Windows行为（相同代码）\ 这台服务器 在Mac和Windows上的相同代码以进行操作。根据操作系统的不同，工具列表也会发生变化，或者只有特定工具被“禁用”的设置。 没有.\ tm_get_tool, tm_post_tool, tm_patch_tool, tm_put_tool, tm_delete_tool包括 所有工具始终注册在配置文件中，也没有按工具启用/禁用的选项。\ 如果Claude提示说：“请在MCP服务器上激活这些工具。” Claude误导的是。 不是服务器端禁用的。 请参见下面的“仅显示部分工具或不支持”进行操作。

3.5使用流程摘要

1. 安装：Python→项目文件夹→ pip install -r requirements.txt
2. 连接：无文件。使用工具时 tmos_host, tmos_用户名, tmos_密码 输入
3. 运行：在终端上 python -m F5MCPserver 或者，在Claude设置中使用run_mcp脚本 绝对路径 指定
4. 使用：Claude在新聊天中要求“设置首选项”、“设置L4标准”、“创建VLAN”等

3.6疑难解答

______________________________________________________________________

4.开发指南和指南

在修改和添加代码时进行匹配是一个很好的目标和规则。

4.1项目目标（维持）

• 目的：将F5设置为 自然语言中相同的品质用于执行的MCP服务器
• 三大功能

1. 默认设置 -hostname、NTP、DNS、syslog、admin/root密码等 1. L4标准设置 -sys_db、LTM connection、标准配置文件 1. 其他 -处理VLAN、Self IP、Pool、Virtual Server、HA、auth user等自然语言

更改代码/文档时，应与上述目的保持三大功能的区分。

4.2代码修改时的核对表

首选项 (Tools/F5object.py, apply_basic_settings)

• \[\]用户 光说给我的钱。 适用。设备查询的值不用作首选参数
• \[\]如果没有一个值 action: "ask_user" + basic_settings_guide / message 返还

AI规则 (prompt_AI에이전트_규칙.md)

• \[\]“不要将未通过语言指定的项目放入apply_basic_setting_tool参数中”等规则是否与实际调用流相匹配
• \[\]首选项、L4标准、HA相关语句是否与代码行为一致

HA冗余 (Tools/F5object.py, apply_ha_settings)

• \[\]当Secondary CM name和Primary发生冲突时 secondary_device_name_actual 应用short form后，使用与add_to_trust/config_sync相同的名称
• \[\]add_to_trustTMSH回退时密码转义（' → '"'"')

工具·连接 (F5MCPserver.py)

• \[\]在所有工具中 tmos_host / tmos_port / tmos_username / tmos_password 一致转发（仅在呼叫时使用连接信息）
• \[ \] apply_basic_settings_tool / apply_ha_tool 参数为 F5object 是否与方法匹配

返回值·错误

• \[\]按步骤返回 { "ok", "step", "result" } 保持形状
• \[ \] action, do_not_report_as_complete 等，区分完成/未完成/ask_user
• \[\]使错误消息中显示失败时的阶段、设备、API（REST vs TMSH）区分

4.3修改文档时

• 更改工具标识和参数时 guide_工具_使用方法.md, prompt_AI代理_规则.md 等，同时修改受影响的指南
• 不保存连接信息。 tmos_host / tmos_username / tmos_password 仅传达到文档中

4.4代码样式·优先级

• 一致性：新工具 tmos_host, tmos_port, tmos_username, tmos_password 收到， _resolve_connection验证后 F5_object(**(conn or {})) 调用
• 错误消息：具体编写以让用户/AI知道原因

______________________________________________________________________

本README中包含了部署、安装和开发指南。详细流程·工具使用方法如下 文档（.md）指南请参考中的每个指南。