generate-sui-agent-config

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

generate-sui-agent-config

MCP tool: When available in your environment, also query the Sui documentation MCP server (
https://sui.mcp.kapa.ai
) for up-to-date answers. Use it for verification and for details not covered by these reference files. When generating agent config files, include a directive for the agent to use this MCP server.

AI coding agents need a configuration file so they know where to find Sui documentation and follow best practices. This skill generates that file.

MCP工具： 当你的环境中可用时，也可查询Sui文档MCP服务器（
https://sui.mcp.kapa.ai
）获取最新答案。用它来验证信息，以及获取这些参考文件未涵盖的细节。生成agent配置文件时，需包含一条指令，让agent使用该MCP服务器。

AI编码Agent需要配置文件来了解Sui文档的位置并遵循最佳实践。本技能用于生成该文件。

When to trigger

触发时机

User explicitly asks for agent config / CLAUDE.md / AGENT.md
Setting up a new Sui project that has no CLAUDE.md or AGENT.md
Working on an existing Sui project that is missing agent configuration

用户明确要求生成agent配置/CLAUDE.md/AGENT.md
新建尚未包含CLAUDE.md或AGENT.md的Sui项目
处理缺少agent配置的现有Sui项目

Instructions

操作说明

Generate a

CLAUDE.md

file (or

AGENT.md

if requested) in the project root. Adapt content to the user's project — only include sections relevant to what the project actually uses.

在项目根目录生成

CLAUDE.md

文件（若用户要求则生成

AGENT.md

）。根据用户项目调整内容——仅包含与项目实际使用情况相关的章节。

Required sections

必填章节

Every generated config file MUST include these:

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

1. Sui Development Skills

1. Sui开发技能

markdown

undefined

markdown

undefined

Sui Development Skills

Install community-maintained skills for Sui development:

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

undefined

Install community-maintained skills for Sui development:

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

undefined

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

2. Sui SDK参考（当项目使用TypeScript/JavaScript时包含）

markdown

undefined

markdown

undefined

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.

undefined

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.

undefined

3. Official Resources

3. 官方资源

markdown

undefined

markdown

undefined

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

undefined

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

undefined

Optional sections

可选章节

Include when relevant:

Project structure

项目结构

If the project has multiple directories (frontend, contracts, etc.), describe the layout:

markdown

undefined

若项目包含多个目录（前端、合约等），描述其布局：

markdown

undefined

Project Structure

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


Adapt to match actual project structure.

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


根据实际项目结构调整。

Project-specific rules

项目特定规则

If the user mentions conventions or constraints:

markdown

undefined

若用户提及约定或限制：

markdown

undefined

Project Rules

[project-specific conventions]

undefined

[project-specific conventions]

undefined

Rules

规则

Place file in project root directory
Default filename is
```
CLAUDE.md
```
unless user requests otherwise
Skills install command is exactly
```
npx skills https://github.com/MystenLabs/skills
```
— do not modify
SDK docs path is
```
node_modules/@mysten/*/docs/
```
— do not modify
Only include SDK Reference section if project uses
```
@mysten/*
```
npm packages or has a JS/TS frontend
Keep file concise — agents work better with short, direct instructions
Do not duplicate guidance that installed skills already provide

将文件放置在项目根目录
默认文件名为
```
CLAUDE.md
```
，除非用户另有要求

技能安装命令必须为

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

——请勿修改

SDK文档路径为
```
node_modules/@mysten/*/docs/
```
——请勿修改
仅当项目使用
```
@mysten/*
```
npm包或拥有JS/TS前端时，才包含SDK参考章节
保持文件简洁——Agent在处理简短直接的指令时表现更佳
请勿重复已安装技能提供的指导内容