English | 简体中文

✨ 为什么用 SapBuddy？

🎯 核心特性

• 💬 自然语言开发：对话完成 SAP 对象查询、分析、开发、审查、测试
• 🛠 41 个内置 SAP 工具：对象搜索 / 源码读取 / where-used / ATC 质量门禁 / 单元测试 / SQL 查询 / 传输请求 / 版本历史 / ST22 dump 分析 / DDIC 管理（表/结构/数据元素/域/CDS）/ 文本元素与多语言翻译
• 🔒 安全三重防线：默认只读 + 开发客户端守卫（T000.CCCATEGORY 非开发类自动拦截写操作）+ 生产环境 fail-closed
• 🖥 CLI + Web 双模式：终端交互 / 浏览器界面（SSE 流式）
• 🔀 多模型：DeepSeek / OpenAI / Anthropic / Qwen 等（pi 生态）
• 🔌 MCP 兼容：可接入外部 MCP 服务器（如 SAP 端 ZSX_MCP），CLI 与 Web 双端自动注册，工具即时可用

📸 截图

Web 对话主界面 —— 浏览器里的对话页面，支持流式输出，随时查看 SAP 连接与模型状态


一次真实对话的成果 —— 用一句大白话让 AI 读取并分析 SAP 对象，直接给出结果

代码审查报告 —— 审查程序自动生成 4 页签 HTML 报告（质量评分 / 规范问题 / ATC）

CLI 终端 —— 命令行全屏交互模式，终端里直接对话

🚀 快速开始

方式 A：npm 全局安装（推荐）

npm install -g sapbuddy
sapbuddy doctor    # 环境自检

方式 B：源码运行

git clone https://github.com/gxx950224/sapbuddy.git
cd sapbuddy
npm install
npm run build

首次配置（两种方式相同）

所有配置保存在 ~/.SapBuddy/（主目录下隐藏目录，固定位置，无论在哪运行 sapbuddy 都用这一份）：auth.json / connections.json / settings.json / sessions / skills / prompts / output。首次运行 sapbuddy 后自动生成配置文件与示例模板（模板副本在 ~/.SapBuddy/config/），按下面填即可。

# 1. AI 模型 API Key（必填）
#    打开 ~/.SapBuddy/auth.json，把 key 里的示例文字换成你的 API Key
#    （参考 ~/.SapBuddy/config/auth.example.json）

# 2. SAP 连接（ADT 需在 SICF 激活 /sap/bc/adt）
#    打开 ~/.SapBuddy/connections.json，填入系统地址/客户端/账号
#    （参考 ~/.SapBuddy/config/connections.example.json）

# 3.（可选）模型与思考级别
#    打开 ~/.SapBuddy/settings.json
#    （参考 ~/.SapBuddy/config/settings.example.json）

开始对话

sapbuddy                           # 直接进入交互式对话（全屏 TUI）
sapbuddy chat                      # 交互式对话（同上）
sapbuddy web                       # Web 版（http://127.0.0.1:7400）
sapbuddy "搜索 ZCL_* 开头的类"      # 单次提问
sapbuddy tools                     # 列出 41 个 SAP 工具 + 已配置的 MCP 工具

🧩 架构

用户 ──CLI / Web──► pi SDK (AgentSession)
                       │  41 个 SAP 工具（直接函数调用）
                       ▼
                  abap-adt-api ──ADT HTTPS──► SAP /sap/bc/adt

• 直接集成：41 个工具是纯函数模块，直接注册为 Agent customTools，不依赖 MCP 框架
• 工具注册在扩展加载期完成；MCP 服务器（可选）通过 async factory 动态注册

📁 项目结构

sapbuddy/
├── cli.mjs                 # CLI 入口（chat / 单次 / web / tools / doctor）
├── src/
│   ├── agent-core.mjs      # pi SDK 会话管理 + 模型解析 + 运行时初始化
│   ├── sap-tools/          # 41 个 SAP 工具（TypeScript，基于 abap-adt-api）
│   └── web/                # 本地 Web 服务器 + UI + MCP 客户端
├── defaults/               # 默认技能与 models.json（随包发布，首次运行拷贝到 ~/.SapBuddy/）
├── config/                 # 配置模板（不含真实凭据）
├── test/                   # 冒烟测试（node --test）
└── docs/                   # 文档

运行时配置（~/.SapBuddy/：auth/连接/会话/技能/产物/MCP）由程序自动初始化并固定存于主目录，不随仓库与 npm 包分发。

🔒 安全

• 默认只读：security.readOnly: true，写操作需显式开启
• 开发客户端守卫（默认开启）：写操作前查询 T000.CCCATEGORY，仅开发类客户端（C 定制/客户开发）允许修改代码；测试（T）/生产（P）/演示（D）/培训（E）/SAP 参考（S）一律拒绝；无法确认时 fail-closed
• SAP 密码与 API Key 永不入库（模板脱敏，.gitignore 排除）
• 写操作需用户先审核改动内容后才执行（Agent 强制门禁）

🧪 测试

npm test        # 冒烟测试：工具加载 / CLI / 构建产物 / 配置模板
npm run check   # TypeScript 类型检查

完整回归矩阵见 docs/TESTING.md。

❓ FAQ

Q：需要什么 SAP 权限？
ADT 服务（/sap/bc/adt）访问权限 + 目标对象读写权限；查询类工具需要相应授权对象。

Q：如何接入自己的模型？
编辑 ~/.SapBuddy/auth.json 配置 API Key，~/.SapBuddy/models.json 添加模型，设置页（Web）可直接切换。

Q：MCP 工具如何使用？
设置-MCP 添加服务器（streamable-http，兼容 SSE 响应），保存后自动连接测试并注册为 mcp_<服务器>_<工具名>，CLI 与 Web 双端同等可用。服务器名来自 mcp.json 的 key，引用时需全小写下划线写法（如 mcp_sap-mcp-dev_GET_TCODE_INFO）。

Q：为什么在测试机上写操作被拒绝？
开发客户端守卫拦截——这是设计意图。仅开发类客户端（默认 C）可写，见 安全。

🗺 Roadmap

• 41 个 SAP 工具（搜索/读码/写/ATC/单测/SQL/DDIC/文本/翻译）
• CLI + Web 双模式
• 开发客户端守卫 + 写前审核门禁
• MCP 服务器接入
• 批量代码审查报告（多对象）
• 自定义工具脚本（SAP 端 JS 插件）
• 团队协作（共享技能/规范包）

🤝 贡献

欢迎 PR！见 CONTRIBUTING.md。代码风格：无分号、双引号、严格 TS。

🙏 致谢

Agent 会话/模型/工具框架基于 pi-coding-agent（@earendil-works/pi-coding-agent）构建；
SAP 工具设计与 ADT 交互参考 marcellourbani/vscode_abap_remote_fs 及其 LM Tools，基于 abap-adt-api 实现。详见 CREDITS.md。

📄 License

MIT