mcpField
G
generate-sui-agent-config

generate-sui-agent-config

github.com/mystenlabsAgent 工作流19345 次安装今天更新
代码仓库

关于 generate-sui-agent-config

为 AI 编码 Agent 创建项目专用 Sui 指引文件的技能，通常生成 CLAUDE.md 或 AGENT.md。它按项目实际内容选取开发技能、SDK 参考和官方资源，避免加入无关章节。

主要功能

  1. 01生成 CLAUDE.md 或 AGENT.md
  2. 02按项目内容调整章节
  3. 03加入 Sui 开发技能指引
  4. 04添加相关 SDK 文档索引
  5. 05引用官方 Sui 和 Move 资源

适用场景

  1. 01为新的 Sui 项目配置 Agent
  2. 02为现有项目补充缺失的 Agent 指引
  3. 03记录 TypeScript 或 JavaScript SDK 参考
  4. 04说明项目结构和约定

MCP 相关

生成的配置会指示 Agent 在可用时查询 Sui 文档 MCP 服务。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/mystenlabs/skills --skill generate-sui-agent-config

安装后在 Claude Code 中输入/generate-sui-agent-config确认已加载。

详细介绍

generate-sui-agent-config

MCP 工具： 如果当前环境支持，请同时查询 Sui 文档 MCP 服务（https://sui.mcp.kapa.ai）以获取最新答案。使用它来核实信息，以及查询这些参考文件未涵盖的细节。生成 Agent 配置文件时，请添加指示 Agent 使用此 MCP 服务的说明。

AI 编码 Agent 需要配置文件，才能知道在哪里查找 Sui 文档并遵循最佳实践。此技能会生成该文件。

触发条件

  • 用户明确要求提供 Agent 配置文件 / CLAUDE.md / AGENT.md
  • 为没有 CLAUDE.md 或 AGENT.md 的全新 Sui 项目进行设置
  • 在缺少 Agent 配置的现有 Sui 项目中工作

说明

在项目根目录生成 CLAUDE.md 文件（如果用户要求，则生成 AGENT.md）。 根据用户的项目调整内容——仅包含与项目实际用途相关的章节。

必需章节

每个生成的配置文件都必须包含以下内容：

1. Sui 开发技能
## Sui Development Skills

Install community-maintained skills for Sui development:

```sh
npx skills https://github.com/MystenLabs/skills


#### 2. Sui SDK Reference (include when project has TypeScript/JavaScript)

```markdown
## Sui SDK Reference

Every `@mysten/*` package ships LLM documentation in its `docs/` directory. When working with
these packages, find the relevant docs by looking for `docs/llms-index.md` files inside
`node_modules/@mysten/*/`. Read the index first to find the page you need, then read that page
for details.
3. 官方资源
## Official Resources

When unsure about Move patterns or Sui APIs, consult these sources. Do not guess or
extrapolate from other blockchains.

- Move Book: https://move-book.com (use https://move-book.com/llms.txt)
- Sui Docs: https://docs.sui.io (use https://docs.sui.io/llms.txt)
- Sui Move examples: https://github.com/MystenLabs/sui/tree/main/examples/move
可选章节

根据需要添加：

项目结构

如果项目有多个目录（前端、合约等），请说明目录布局：

## Project Structure

- `contracts/` — Move smart contracts
- `app/` — Frontend application

根据项目实际结构调整。

项目特定规则

如果用户提及约定或限制：

## Project Rules

- [project-specific conventions]

规则

  • 将文件放在项目根目录
  • 默认文件名为 CLAUDE.md，除非用户另有要求
  • 技能安装命令必须严格使用 npx skills https://github.com/MystenLabs/skills，不得修改
  • SDK 文档路径必须严格使用 node_modules/@mysten/*/docs/，不得修改
  • 仅当项目使用 @mysten/* npm 包或包含 JS/TS 前端时，才包含 SDK Reference 章节
  • 文件应保持简洁——简短、直接的说明更有利于 Agent
  • 不要重复已安装技能提供的指导

评论

支持 Markdown