跳到主要内容

ionet-ai

介绍

ionet-ai 是面向 ionet 的本地知识库,用来保存可解释、可维护、可治理的框架知识、规则、模板、检查清单和 MCP/CLI 组装能力。

它不是通用 RAG 仓库,也不是把文档内容重新复制一份的入口。它的重点是把 ionet 中稳定、经过约束的知识资产提供给 AI 编程工具,让 Codex CLI、Claude Code CLI 等工具在生成、解释、审查和修改 ionet 代码时,优先遵守 ionet 的真实框架边界。

使用者可以获得这些收益:

  • 减少 AI 生成 ionet 代码时的通用 Java 偏移和框架幻觉。
  • 在本地项目中直接使用 ionet 的稳定规则、模板和检查清单。
  • 通过 MCP 工具进行知识检索、上下文组装、请求诊断和项目校验。
  • 在 Codex CLI 与 Claude Code CLI 中复用同一套 ionet 知识库配置。
  • 使用本地完整仓库作为知识来源,不依赖维护者本地的训练素材目录。

公开入口:

如何在 Codex CLI 中安装

准备 ionet-ai

先在本地准备 ionet-ai 仓库,并安装 MCP 运行依赖。

git clone https://github.com/iohao/ionet-ai.git
cd ionet-ai
uv sync --extra mcp

可以用下面的命令确认 CLI 可用。

uv run ionet-ai --help

安装到你的项目

ionet-ai 仓库根目录执行安装脚本,将知识库安装到目标 ionet 项目。

bash scripts/install-project.sh --project /path/to/your-project

安装后,目标项目中会生成或更新这些 Codex 相关入口:

/path/to/your-project/.codex/skills/ionet-ai
/path/to/your-project/AGENTS.md
/path/to/your-project/codex-ionet.sh
/path/to/your-project/.mcp.json

其中:

  • .codex/skills/ionet-ai/ 是安装到项目中的可读知识资产。
  • AGENTS.md 是 Codex CLI 的项目说明入口。
  • codex-ionet.sh 是推荐的 Codex CLI 启动脚本。
  • .mcp.json 保存 ionet-ai MCP 服务配置,也可供支持项目级 MCP 的客户端使用。

启动 Codex CLI

进入目标项目根目录后执行:

./codex-ionet.sh

codex-ionet.sh 会在当前 Codex 进程中挂载 ionet-ai MCP 服务,不会写入全局 ~/.codex/config.toml,也不会影响其他项目。

如果 Codex CLI 提示 unknown MCP server 'ionet-ai',优先使用 ./codex-ionet.sh 启动当前项目,而不是用 codex mcp add 写入全局配置。

如何在 Claude Code CLI 中安装

Claude Code CLI 使用同一个安装脚本。

准备 ionet-ai

git clone https://github.com/iohao/ionet-ai.git
cd ionet-ai
uv sync --extra mcp

安装到你的项目

ionet-ai 仓库根目录执行:

bash scripts/install-project.sh --project /path/to/your-project

安装后,目标项目中会生成或更新这些 Claude Code 相关入口:

/path/to/your-project/CLAUDE.md
/path/to/your-project/.mcp.json

其中:

  • CLAUDE.md 是 Claude Code CLI 的项目说明入口。
  • .mcp.json 是 Claude Code CLI 使用的项目级 MCP 服务配置。

.mcp.json 中的 ionet-ai 服务会通过类似下面的命令启动:

uv run --project /path/to/ionet-ai --extra mcp ionet-ai serve mcp

启动 Claude Code CLI

进入目标项目根目录后执行:

claude

Claude Code CLI 会读取目标项目中的 CLAUDE.md,并通过 .mcp.json 启动 ionet-ai MCP 服务。首次使用项目级 MCP 服务时,Claude Code 可能会要求确认该服务是否可信。

提示词测试

安装完成并通过 CLI 启动后,可以在目标项目中输入下面的提示词,测试 ionet-ai 是否能正确识别 ionet 项目结构、生成框架代码,并遵守相关规则。

  • 用 ionet 写一个登录示例。
  • 我发现项目还没有启动类,帮我加一个启动类。
  • 帮我写几个广播示例,需要包含单人广播、多人广播、全服广播、给自己广播,广播数据暂时用 String 测试。
  • 添加一个元信息、附加信息的示例。
  • 帮我在“给自己广播”的方法中添加一个 2 秒延时任务,如果自己的 userId10,就取消这个延时任务。
  • 帮我自定义一个对外服。
  • 添加一个心跳钩子。
  • 添加一个用户上下线钩子。
  • 帮我添加路由访问权限控制。
  • 在逻辑服中获取统计人数。
  • 帮我扩展 JSON 数据协议。

反馈

如果在使用过程中发现生成结果不符合 ionet 约定、提示词无法触发预期能力,或项目校验结果存在疑问,可以通过 GitHub Issues 反馈。

反馈时建议包含:

  • 使用的 CLI,例如 Codex CLI 或 Claude Code CLI。
  • 输入的原始提示词。
  • 目标项目的大致结构,或相关类名、包名、模块名。
  • 生成结果中不符合预期的代码片段或错误信息。
  • 如果执行过校验命令,可以附上 validate-project 的输出。

总结

ionet-ai 更适合作为 ionet 项目的本地 AI 编程辅助层:它把稳定知识、候选知识、规则、模板、检查清单和 MCP 工具放在同一个可审查的仓库中,让 AI 工具在处理 ionet 项目时有明确的来源、边界和校验方式。

推荐的使用方式是:每个 ionet 项目通过 scripts/install-project.sh 安装一次,然后在 Codex CLI 中使用 ./codex-ionet.sh 启动,在 Claude Code CLI 中直接使用 claude 启动。生成或修改代码后,可以使用下面的命令检查项目是否违反已机制化的 ionet 规则。

uv run --project /path/to/ionet-ai ionet-ai validate-project --project /path/to/your-project