Skip to main content
skill CX Codex

generate-sui-agent-config — Claude Code skill: guide and install

generate-sui-agent-config — a skill for Claude Code and Codex generates CLAUDE.md or AGENT.md config files in Sui projects. Triggers when starting a new repo or when agent instructions are missing.

Apache-2.0 391 installs ★ 25 updated 2026-11-12

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add MystenLabs/skills --skill generate-sui-agent-config -a claude-code
Open on GitHub

What generate-sui-agent-config does

The skill inspects the repository and writes a configuration file directly into the project root. By default, it generates CLAUDE.md, switching to AGENT.md upon explicit request. The resulting file includes verified resources: the Move Book, official Sui documentation with llms.txt endpoints, and official Move contract examples.

When TypeScript or JavaScript packages under @mysten/* exist in the tree, the skill configures the agent to read docs/llms-index.md inside node_modules/@mysten/*/. It also adds a directive pointing the agent toward the Sui documentation MCP server at https://sui.mcp.kapa.ai for verification.

The skill install command inside the generated configuration is pinned strictly to npx skills https://github.com/MystenLabs/skills. Irrelevant sections are omitted so the agent receives only compact, actionable rules.

What it helps with

  • scaffold a CLAUDE.md or AGENT.md file in a Sui repository root
  • point coding agents to Move Book and Sui docs via llms.txt endpoints
  • route LLM context retrieval to @mysten/* docs inside node_modules
  • insert directives to verify Move code via the Sui MCP documentation server

Example prompts for the agent

  • Generate a CLAUDE.md file for this Sui project
  • Create an AGENT.md config for our Move contracts and web app
  • Set up agent configuration for Sui development

How to install generate-sui-agent-config

1Skills CLI (Vercel)

npx skills add MystenLabs/skills --skill generate-sui-agent-config -a claude-code

2Manually: put the files in place

~/.claude/skills/generate-sui-agent-config/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/generate-sui-agent-config/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about generate-sui-agent-config

How to install generate-sui-agent-config in Claude Code?

Run npx skills add MystenLabs/skills --skill generate-sui-agent-config -a claude-code. The file is saved to ~/.claude/skills/generate-sui-agent-config/SKILL.md.

What does generate-sui-agent-config do?

It writes a tailored agent instructions file containing official Sui documentation links, SDK guidance, and project structure details.

What is required to run generate-sui-agent-config?

You need Node.js to execute npx. When available, the documentation MCP server at https://sui.mcp.kapa.ai supplies real-time reference data.

Source text

SKILL.md · Apache-2.0
---
name: generate-sui-agent-config
description: >
  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.
---

# 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

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

```markdown
## 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:

```markdown
## 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:

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

© MystenLabs · Apache-2.0 · MystenLabs/skills

Similar skills

All skills for Agent setup: memory, context, orchestration →

From the same set30

The whole set →
walrus-sites walrus-sites — a Claude Code skill for deploying, updating, and serving decentralized websites on Walrus and Sui. Helps set up a local portal for testnet and configure routing in ws-resources.json. CX Codex +1 467installs sui-client sui-client — a skill for Claude Code and Codex that handles Sui CLI setup, address management, and faucet tokens. Triggers on network switches, coin merges, or gas coin errors. CX Codex +1 403installs sui-overview The sui-overview Claude Code skill explains Sui’s design and ecosystem. It activates for blockchain comparisons, Sui architecture planning, and questions about moving from Ethereum or Solana. CX Codex +1 400installs sui-publish sui-publish — a skill for Claude Code deploys, tests, and upgrades Sui Move smart contract packages. Triggers on requests to publish packages, manage UpgradeCap, or troubleshoot dry run deployment failures. CX Codex +1 399installs move-security The move-security Claude Code skill reviews security in Sui Move contracts. It activates for package audits, access-control design, and checks involving keys or randomness. CX Codex +1 381installs sui-networks-gas The sui-networks-gas Claude Code skill explains Sui networks and gas costs. It activates for questions about Mainnet, Testnet, Devnet, Localnet, gas budgets, or epochs. CX Codex +1 184installs deepbook-overview The deepbook-overview Claude Code skill explains DeepBook V3 on Sui and its integration options. It activates for questions about the order book, pool internals, DEEP, or mainnet IDs. CX Codex +1 183installs deepbook-sdk The deepbook-sdk Claude Code skill covers TypeScript integration with DeepBook V3 pools. It activates for trading apps, bots, and scripts built with @mysten/deepbook-v3. CX Codex +1 183installs

Project sponsors

Companies that keep this analytics open