Skip to content

Commit d734162

Browse files
codebycarsoncodebycarson
committed
Added icons to everyhing
1 parent 840c861 commit d734162

30 files changed

Lines changed: 86 additions & 484 deletions

‎docs/contributing.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Contributing
33
description: Contributing to @sei-js - Complete guide to local development setup, testing, and pull request process
4+
icon: "hand-heart"
45
---
56

67
## 🚀 Getting Started

‎docs/create-sei/quick-start.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: 'Quick Start'
33
description: 'Get started with @sei-js/create-sei in minutes'
4+
icon: "play"
45
---
56

67
## Installation

‎docs/create-sei/templates.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Templates"
33
description: "Choose from a collection of templates to quickly scaffold your Sei dApps. Each template comes pre-configured with wallet connection, network setup, and essential development tools."
4+
icon: "grid-2"
45
---
56

67
<Info>

‎docs/create-sei/welcome.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: 'Introduction'
33
description: 'CLI tool for scaffolding Sei applications'
4+
icon: "hammer"
45
---
56

67
## Overview

‎docs/docs.json‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
"pages": [
9191
{
9292
"group": "Getting Started",
93-
"pages": ["precompiles/index", "precompiles/quick-start"]
93+
"pages": ["precompiles/introduction", "precompiles/quick-start"]
9494
},
9595
{
9696
"group": "Integrations",
@@ -101,7 +101,6 @@
101101
"pages": [
102102
"precompiles/precompiles/address",
103103
"precompiles/precompiles/bank",
104-
"precompiles/precompiles/confidential-transfers",
105104
"precompiles/precompiles/distribution",
106105
"precompiles/precompiles/governance",
107106
"precompiles/precompiles/ibc",

‎docs/introduction.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Welcome to @sei-js
33
description: A TypeScript SDK for building decentralized applications on Sei
4+
icon: "rocket"
45
---
56

67
## 🚀 Build on Sei

‎docs/ledger/introduction.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: '@sei-js/ledger'
33
description: 'Ledger hardware wallet integration for Sei'
4+
icon: "shield"
45
---
56

67
## Overview

‎docs/mcp-server/context.mdx‎

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,8 @@ The Sei MCP Server includes intelligent documentation search that reads the enti
1111
The MCP server can search and reference documentation for all @sei-js packages:
1212

1313
- **@sei-js/precompiles** - Precompile contract reference and integration examples
14-
- **@sei-js/cosmos** - Cosmos SDK integration patterns
1514
- **@sei-js/sei-global-wallet** - EIP-6963 wallet standard implementation
15+
- **@sei-js/mcp-server** - Model Context Protocol server for LLMs
1616
- **@sei-js/registry** - Network configuration and asset information
1717
- **@sei-js/create-sei** - Project scaffolding and templates
1818
- **@sei-js/ledger** - Hardware wallet integration
19-
- **@sei-js/confidential-transfers** - Privacy-preserving transactions
20-
21-
## What the AI Can Help With
22-
23-
```text
24-
"How do I use the Bank precompile to check token balances?"
25-
"Show me how to integrate Oracle precompile with Viem"
26-
"Generate a wallet connection component using @sei-js/sei-global-wallet"
27-
"Help me set up a new Sei project with the latest patterns"
28-
```
29-
30-
## Code Generation
31-
32-
The AI generates accurate, production-ready code using official @sei-js patterns:
33-
34-
- Uses correct package imports and APIs
35-
- Follows documented best practices
36-
- Includes proper error handling
37-
- References current version patterns

‎docs/mcp-server/introduction.mdx‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Add the Sei MCP Server to your AI assistant with this configuration:
4343

4444
## What is MCP?
4545

46-
The Model Context Protocol is an open standard that connects AI systems with external tools and data sources. It enables:
46+
The Model Context Protocol is an open standard that connects AI systems with custom prompts, tools and data sources (context). It enables:
4747

4848
- **Real-time blockchain data access** - Get current balances, transaction history, and network status directly from Sei
4949
- **Full execution and write operations** - Deploy contracts, execute transactions, and interact with smart contracts
@@ -72,6 +72,23 @@ The Sei MCP Server leverages this protocol to bring comprehensive blockchain fun
7272
</Accordion>
7373
</AccordionGroup>
7474

75+
## Example Queries
76+
77+
```text
78+
"How do I query staking my delegations using Viem?"
79+
"Generate a wallet connection component using Sei Global Wallet"
80+
"Help me set up a new Sei project with the latest patterns"
81+
```
82+
83+
## Code Generation
84+
85+
The AI generates accurate, production-ready code using official @sei-js patterns:
86+
87+
- Uses correct package imports and APIs
88+
- Follows documented best practices
89+
- Includes proper error handling
90+
- References current version patterns
91+
7592
<Note>
7693
The Sei MCP Server is actively developed with new features added regularly. Current version supports core blockchain operations with advanced DeFi integrations planned.
77-
</Note>
94+
</Note>

‎docs/mcp-server/tools.mdx‎

Lines changed: 39 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -10,80 +10,71 @@ The Sei MCP Server provides 28 tools for blockchain operations. Ask your AI assi
1010

1111
| Tool | Purpose | Example Usage |
1212
|------|---------|---------------|
13-
| `get-address-from-private-key` | Get wallet address | "What's my wallet address?" |
14-
| `get-balance` | Check SEI balance | "What's my SEI balance?" |
15-
| `transfer-sei` | Send SEI tokens | "Send 1 SEI to 0x742d..." |
16-
| `is-contract` | Check if address is contract | "Is 0x3894... a contract?" |
17-
| `estimate-gas` | Estimate transaction gas cost | "How much gas for this transaction?" |
13+
| `get_address_from_private_key` | Get wallet address | "What's my wallet address?" |
14+
| `get_balance` | Check SEI balance | "What's my SEI balance?" |
15+
| `transfer_sei` | Send SEI tokens | "Send 1 SEI to 0x742d..." |
16+
| `is_contract` | Check if address is contract | "Is 0x3894... a contract?" |
17+
| `estimate_gas` | Estimate transaction gas cost | "How much gas for this transaction?" |
1818

1919
## Network & Blockchain Data
2020

2121
| Tool | Purpose | Example Usage |
2222
|------|---------|---------------|
23-
| `get-chain-info` | Get network information | "Show me Sei network info" |
24-
| `get-supported-networks` | List supported networks | "What networks are supported?" |
25-
| `get-latest-block` | Get latest block | "Get latest block" |
26-
| `get-block-by-number` | Get specific block | "Get block 12345" |
27-
| `get-transaction` | Get transaction details | "Analyze transaction 0xabc..." |
28-
| `get-transaction-receipt` | Get transaction receipt | "Get receipt for 0xabc..." |
23+
| `get_chain_info` | Get network information | "Show me Sei network info" |
24+
| `get_supported_networks` | List supported networks | "What networks are supported?" |
25+
| `get_latest_block` | Get latest block | "Get latest block" |
26+
| `get_block_by_number` | Get specific block | "Get block 12345" |
27+
| `get_transaction` | Get transaction details | "Analyze transaction 0xabc..." |
28+
| `get_transaction_receipt` | Get transaction receipt | "Get receipt for 0xabc..." |
2929

3030
## Token Management (ERC-20)
3131

3232
| Tool | Purpose | Example Usage |
3333
|------|---------|---------------|
34-
| `get-token-info` | Get ERC-20 token details | "Get info for token 0x3894..." |
35-
| `get-token-balance` | Check token balance | "What's my USDC balance?" |
36-
| `get-erc20-balance` | Check ERC-20 balance | "Check ERC20 balance for 0x742d..." |
37-
| `get-token-balance-erc20` | Get ERC-20 token balance | "Get token balance for address" |
38-
| `transfer-token` | Send ERC-20 tokens | "Send 100 USDC to 0x742d..." |
39-
| `transfer-erc20` | Transfer ERC-20 tokens | "Transfer tokens to address" |
40-
| `approve-token-spending` | Approve token spending | "Approve 1000 USDC for 0xDEX..." |
34+
| `get_token_info` | Get ERC-20 token details | "Get info for token 0x3894..." |
35+
| `get_token_balance` | Check token balance | "What's my USDC balance?" |
36+
| `get_erc20_balance` | Check ERC-20 balance | "Check ERC20 balance for 0x742d..." |
37+
| `get_token_balance_erc20` | Get ERC-20 token balance | "Get token balance for address" |
38+
| `transfer_token` | Send ERC-20 tokens | "Send 100 USDC to 0x742d..." |
39+
| `transfer_erc20` | Transfer ERC-20 tokens | "Transfer tokens to address" |
40+
| `approve_token_spending` | Approve token spending | "Approve 1000 USDC for 0xDEX..." |
4141

4242
## NFT Operations (ERC-721)
4343

4444
| Tool | Purpose | Example Usage |
4545
|------|---------|---------------|
46-
| `get-nft-info` | Get NFT details | "Get info for NFT token 123" |
47-
| `check-nft-ownership` | Verify NFT ownership | "Do I own NFT token 123?" |
48-
| `transfer-nft` | Transfer NFT | "Transfer NFT token 123 to 0x742d..." |
49-
| `get-nft-balance` | Count NFTs owned | "How many NFTs do I own?" |
46+
| `get_nft_info` | Get NFT details | "Get info for NFT token 123" |
47+
| `check_nft_ownership` | Verify NFT ownership | "Do I own NFT token 123?" |
48+
| `transfer_nft` | Transfer NFT | "Transfer NFT token 123 to 0x742d..." |
49+
| `get_nft_balance` | Count NFTs owned | "How many NFTs do I own?" |
5050

5151
## Multi-Token Operations (ERC-1155)
5252

5353
| Tool | Purpose | Example Usage |
5454
|------|---------|---------------|
55-
| `get-erc1155-balance` | Get ERC-1155 token balance | "Check my ERC1155 token balance" |
56-
| `get-erc1155-token-uri` | Get ERC-1155 metadata URI | "Get metadata for token ID 123" |
57-
| `transfer-erc1155` | Transfer ERC-1155 tokens | "Transfer ERC1155 token to address" |
55+
| `get_erc1155_balance` | Get ERC-1155 token balance | "Check my ERC1155 token balance" |
56+
| `get_erc1155_token_uri` | Get ERC-1155 metadata URI | "Get metadata for token ID 123" |
57+
| `transfer_erc1155` | Transfer ERC-1155 tokens | "Transfer ERC1155 token to address" |
5858

5959
## Smart Contract Operations
6060

6161
| Tool | Purpose | Example Usage |
6262
|------|---------|---------------|
63-
| `read-contract` | Read contract data | "Read balanceOf from contract 0x3894..." |
64-
| `write-contract` | Execute contract function | "Call contract function with params" |
65-
| `deploy-contract` | Deploy new contract | "Deploy contract with bytecode" |
63+
| `read_contract` | Read contract data | "Read balanceOf from contract 0x3894..." |
64+
| `write_contract` | Execute contract function | "Call contract function with params" |
65+
| `deploy_contract` | Deploy new smart contract | "Deploy my token contract" |
6666

67-
## Resource URIs
67+
## Documentation
6868

69-
Access blockchain data programmatically:
70-
71-
```text
72-
# Network data
73-
evm://sei/chain
74-
evm://sei-testnet/chain
75-
76-
# Block information
77-
evm://sei/block/latest
78-
evm://sei/block/12345
79-
80-
# Transactions
81-
evm://sei/tx/0xabc123...
82-
evm://sei/tx/0xabc123.../receipt
69+
| Tool | Purpose | Example Usage |
70+
|------|---------|---------------|
71+
| `search_sei_js_docs` | Search Sei-JS documentation | "How do I use precompiles with Viem?" |
8372

84-
# Token data
85-
evm://sei/token/0x3894.../balanceOf/0x742d...
73+
## Security Notes
8674

87-
# NFT data
88-
evm://sei/nft/0xNFT_ADDRESS/123
89-
evm://sei/nft/0xNFT_ADDRESS/123/isOwnedBy/0x742d...
75+
<Warning>
76+
The MCP server requires a `PRIVATE_KEY` environment variable for transaction signing. Ensure this key is:
77+
- Kept secure and never shared
78+
- Only used with funds you can afford to lose
79+
- Properly backed up before use
80+
</Warning>

0 commit comments

Comments
 (0)