Skip to content

Commit b43067f

Browse files
authored
enhance readme (#37)
1 parent d6b0ce2 commit b43067f

File tree

2 files changed

+62
-23
lines changed

2 files changed

+62
-23
lines changed

README.md

Lines changed: 62 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,56 @@
1-
# Substrate MCP Server
1+
<div align="center">
2+
<img src="./docs/images/Polkadot-Logo.png" alt="Polkadot logo" height="300" width="500">
3+
4+
# ✨ Substrate MCP Server ✨
5+
6+
An MCP (Model Context Protocol) server that provides tools for working with Substrate-based blockchains.
7+
</div>
8+
9+
## Table of Contents
10+
11+
- [📖 About](#-about)
12+
- [🛠️ Prerequisites](#-prerequisites)
13+
- [⬇ Installation](#-installation)
14+
- [Quick Install](#quick-install)
15+
- [Download from Releases](#download-from-releases)
16+
- [Install from Source (Requires cargo)](#install-from-source)
17+
- [Build Locally (Requires cargo)](#build-locally)
18+
- [🤖 Usage with Claude Code](#-usage-with-claude-code)
19+
- [🎛️ Configuration](#%EF%B8%8F-configuration)
20+
- [GitHub API Rate Limits](#github-api-rate-limits)
21+
- [⚙️ Available Tools](#-available-tools)
22+
- [Release Analysis](#release-analysis)
23+
- [Chain Exploration](#chain-exploration)
24+
- [Extrinsic Operations](#extrinsic-operations)
25+
- [🚀 Available Prompts](#-available-prompts)
26+
- [Polkadot SDK Release Analysis](#polkadot-sdk-release-analysis)
27+
- [release_comparison](#release_comparison)
28+
- [analyze_release](#analyze_release)
29+
- [polkadot_upgrade](#polkadot_upgrade)
30+
- [Development & Scaffolding](#development--scaffolding)
31+
- [scaffold_pallet](#scaffold_pallet)
32+
- [Security Analysis](#security-analysis)
33+
- [security_review](#security_review)
34+
- [📜 License](#-license)
35+
36+
## 📖 About
37+
Substrate MCP is a Rust-based Model Context Protocol server for the [Polkadot](https://polkadot.com/) ecosystem.
38+
It lets AI agents explore chain metadata and state, decode extrinsics, submit dev extrinsics, scaffold pallets, and analyze [Polkadot SDK](https://polkadot.com/platform/sdk/) releases to understand their impact on your codebase.
39+
40+
## 🛠 Prerequisites
41+
42+
- [Rust Toolchain](https://www.rust-lang.org/tools/install)
43+
44+
- For the `subxt_execute` tool, install the subxt CLI:
245

3-
An MCP (Model Context Protocol) server that provides tools for working with Substrate-based blockchains.
46+
```bash
47+
cargo install subxt-cli
48+
```
449

5-
## Installation
50+
## ⬇ Installation
51+
Choose one of the following installation methods:
652

7-
### 1: Quick Install
53+
### Quick Install
854

955
```bash
1056
curl -sSfL https://raw.githubusercontent.com/Moonsong-Labs/substrate-mcp/main/install.sh | bash
@@ -15,17 +61,17 @@ This will:
1561
- Install it to `~/.substrate-mcp/bin/substrate-mcp`
1662
- Add the binary to your PATH
1763

18-
### 2: Download from Releases
64+
### Download from Releases
1965

2066
Download the binary for your platform from the [latest release](https://github.com/Moonsong-Labs/substrate-mcp/releases/latest).
2167

22-
### 3: Install from Source (Requires cargo)
68+
### Install from Source
2369

2470
```bash
2571
cargo install --locked --git https://github.com/Moonsong-Labs/substrate-mcp
2672
```
2773

28-
### 4: Build Locally (Requires cargo)
74+
### Build Locally
2975

3076
```bash
3177
git clone https://github.com/Moonsong-Labs/substrate-mcp.git
@@ -35,15 +81,7 @@ cargo build --release
3581

3682
The binary will be available at `./target/release/substrate-mcp`
3783

38-
## Prerequisites
39-
40-
For the `subxt_execute` tool, install the subxt CLI:
41-
42-
```bash
43-
cargo install subxt-cli
44-
```
45-
46-
## Usage with Claude Code
84+
## 🤖 Usage with Claude Code
4785

4886
To use this MCP server with Claude Code, add it to your Claude Code configuration.
4987

@@ -69,13 +107,13 @@ If you built the server locally instead of installing it, use the full path:
69107
}
70108
```
71109

72-
Alternatively, you can add using cli:
110+
Alternatively, add via CLI:
73111

74-
```
112+
```bash
75113
claude mcp add substrate /path/to/substrate-mcp/target/release/substrate-mcp
76114
```
77115

78-
## Configuration
116+
## 🎛️ Configuration
79117

80118
### GitHub API Rate Limits
81119

@@ -107,11 +145,12 @@ For Claude Code, you can set environment variables in your configuration:
107145
}
108146
```
109147

110-
## Available Tools
148+
## ⚙️ Available Tools
111149

112150
### Release Analysis
113151

114152
- **`fetch_and_analyze_release`** - Fetches and analyzes a Polkadot SDK release - downloads PRDocs and generates summaries (manifest, crate changes, audience breakdown)
153+
- **`find_runtime_pallets`** - Find and analyze runtime pallets configured in a given project directory. Scans for #[frame_support::runtime] attributes to discover all pallets used in your runtime(s)
115154
- **`list_polkadot_releases`** - List all available Polkadot SDK releases from the polkadot-sdk repository. Helps discover valid release identifiers before using other tools. Supports filtering by release type (stable, legacy, or all)
116155

117156
### Chain Exploration
@@ -127,7 +166,7 @@ For Claude Code, you can set environment variables in your configuration:
127166

128167
- **`submit_dev_extrinsic`** - Submit a generic extrinsic to a Substrate chain using dev accounts. Supports any pallet call with arbitrary arguments. Use dev account names like 'alice', 'bob', 'charlie', etc. for signing
129168

130-
## Available Prompts
169+
## 🚀 Available Prompts
131170

132171
The Substrate MCP server provides several specialized prompts for Substrate development and security analysis:
133172

@@ -178,6 +217,6 @@ The Substrate MCP server provides several specialized prompts for Substrate deve
178217

179218
This prompt combines code security audit, economic security assessment, threat modeling, and weight analysis into a comprehensive security review. NOTE: This prompt is designed to be used during development as a tool to provide an extra layer of analysis. It is not meant to replace professional security audits.
180219

181-
## License
220+
## 📜 License
182221

183-
[LICENSE](LICENSE)
222+
This Project is licenced under the Apache License. See the [LICENSE](LICENSE) file for details

docs/images/Polkadot-Logo.png

136 KB
Loading

0 commit comments

Comments
 (0)