> For the complete documentation index, see [llms.txt](https://ossybadman.gitbook.io/suins-mcp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ossybadman.gitbook.io/suins-mcp/readme.md).

# suins-mcp

MCP server for Sui Name Service. Lets AI agents resolve `.sui` names, look up identities, and build SuiNS transactions.

***

## Integration

### Option A: Direct Integration (Remote MCP)

If your client supports adding a remote MCP server, use these details:

* **Server Name:** `suins-mcp`
* **URL:** `https://suins-mcp-production.up.railway.app/mcp`

***

### Option B: Using Cursor

Add to your MCP configuration file:

```json
{
  "mcpServers": {
    "suins": {
      "transport": "http",
      "url": "https://suins-mcp-production.up.railway.app/mcp"
    }
  }
}
```

***

### Option C: Using Claude Code

Run this command in your terminal:

```bash
claude mcp add --transport http suins-mcp https://suins-mcp-production.up.railway.app/mcp
```

***

## Tools

### Query tools

| Tool                  | Description                                              |
| --------------------- | -------------------------------------------------------- |
| `resolve_name`        | Resolve a `.sui` name to a wallet address                |
| `reverse_lookup`      | Find the `.sui` name(s) for a wallet address             |
| `get_name_record`     | Get full details (expiry, avatar, contentHash) of a name |
| `check_availability`  | Check if a `.sui` name is available to register          |
| `get_pricing`         | Get current registration pricing by name length          |
| `get_renewal_pricing` | Get current renewal pricing by name length               |

***

### Transaction tools

These tools build unsigned Sui PTBs. The returned `txBytes` must be signed and executed by the caller's wallet.

| Tool                           | Description                                         |
| ------------------------------ | --------------------------------------------------- |
| `build_register_tx`            | Register a new `.sui` name                          |
| `build_renew_tx`               | Renew an existing `.sui` name                       |
| `build_create_subname_tx`      | Create a node subname with its own NFT              |
| `build_create_leaf_subname_tx` | Create a leaf subname e.g. `ossy.t2000.sui`         |
| `build_remove_leaf_subname_tx` | Remove a leaf subname                               |
| `build_set_target_address_tx`  | Point a name at a wallet address                    |
| `build_set_default_name_tx`    | Set a name as default for the signer address        |
| `build_edit_subname_setup_tx`  | Toggle child creation / time extension on a subname |
| `build_extend_expiration_tx`   | Extend a subname expiration                         |
| `build_set_metadata_tx`        | Set avatar, content hash, or walrus site ID         |
| `build_burn_expired_tx`        | Burn expired name to reclaim storage rebates        |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ossybadman.gitbook.io/suins-mcp/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.