agentleFS
MystenLabsMystenLabs/skills/generate-sui-agent-config/SKILL.md

generate-sui-agent-config

Skill20 starsChanged 15 days agoApache-2.0View on GitHub

Generate a CLAUDE.md or AGENT.md configuration file for Sui projects. Use when setting up a new Sui project, when user mentions "CLAUDE.md", "AGENT.md", "agent config", or when working on a Sui project that does not already have a CLAUDE.md or AGENT.md in the project root.

The file

We split this skill into the rules it gives an agent

8 rules. About 0 are common, 6 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every generated config file MUST include these:

    line 31
  2. Distinctive:

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

    line 75
  3. Distinctive:

    If the user mentions conventions or constraints:

    line 88
  4. Distinctive:

    Place file in project root directory

    line 98
  5. Distinctive:

    Default filename is CLAUDE.md unless user requests otherwise

    line 99
  6. Very specific:

    Only include SDK Reference section if project uses @mysten/* npm packages or has a JS/TS frontend

    line 102
  7. Distinctive:

    Keep file concise — agents work better with short, direct instructions

    line 103
  8. Very specific:

    Do not duplicate guidance that installed skills already provide

    line 104

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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.

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

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.

Required sections

Every generated config file MUST include these:

1. Sui Development Skills

## 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

## 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

Optional sections

Include when relevant:

Project structure

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

## Project Structure

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

Adapt to match actual project structure.

Project-specific rules

If the user mentions conventions or constraints:

## Project Rules

- [project-specific conventions]

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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.