Skip to content

Commit de7c112

Browse files
committed
docs(mcp): Add comprehensive documentation for all 75+ osvm-mcp tools
**Complete MCP Tool Coverage:** 1. MCP_TOOLS_REFERENCE.md (750+ lines) - Complete documentation of all 31 specialized tools - 90+ Solana RPC methods via solana_rpc_call - 8 tool categories with examples: * Account tools (6 tools) * Transaction tools (4 tools) * Block tools (3 tools) * Analytics tools (4 tools) * Token & NFT tools (4 tools) * Search tools (2 tools) * Utility tools (5 tools) * Monetization tools (3 tools) - Full parameter formats and return values - Best practices and troubleshooting - Real OVSM code examples for each tool 2. mcp_comprehensive_demo.ovsm (200+ lines) - Working demonstration of all 8 tool categories - Shows account stats, portfolio, transactions - DeFi analytics, token info, block data - Direct RPC access examples - Production-ready error handling 3. Updated MCP_INTEGRATION_README.md - Links to complete tool reference - Quick start with comprehensive demo - Better organization of examples **Why This Matters:** - Developers can find any tool instantly - Each tool has working code examples - Covers 100% of osvm-mcp capabilities - Self-documenting with dynamic discovery **Testing:** ✅ All tools documented with parameter formats ✅ Comprehensive demo exercises 8 categories ✅ Real examples using test wallet ✅ Properly references osvm-mcp README
1 parent d032259 commit de7c112

File tree

3 files changed

+992
-5
lines changed

3 files changed

+992
-5
lines changed

examples/ovsm_scripts/MCP_INTEGRATION_README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,24 @@ osvm mcp list # Verify it's registered
4040

4141
## Available Examples
4242

43-
### 1. Basic RPC Operations (`mcp_basic_rpc.ovsm`)
43+
### 1. Comprehensive Demo (`mcp_comprehensive_demo.ovsm`) ⭐ START HERE
44+
45+
**Complete demonstration of all 8 tool categories:**
46+
- Account tools (stats, portfolio, type checking)
47+
- Transaction tools (details, analysis, explanations)
48+
- Block tools (current block, stats, recent blocks)
49+
- DeFi analytics (TVL, volume, protocols)
50+
- Token tools (metadata, info, holders)
51+
- Search tools (universal search)
52+
- Direct RPC access (90+ Solana methods)
53+
- Utility tools (program registry)
54+
55+
**Run:**
56+
```bash
57+
osvm ovsm run examples/ovsm_scripts/mcp_comprehensive_demo.ovsm --debug
58+
```
59+
60+
### 2. Basic RPC Operations (`mcp_basic_rpc.ovsm`)
4461

4562
Demonstrates fundamental blockchain queries:
4663
- `getSlot()` - Current slot number
@@ -54,7 +71,7 @@ Demonstrates fundamental blockchain queries:
5471
osvm ovsm run examples/ovsm_scripts/mcp_basic_rpc.ovsm
5572
```
5673

57-
### 2. Wallet Activity Dashboard (`mcp_wallet_analysis.ovsm`)
74+
### 3. Wallet Activity Dashboard (`mcp_wallet_analysis.ovsm`)
5875

5976
Comprehensive wallet analysis showing:
6077
- Transaction success/failure rates
@@ -67,7 +84,7 @@ Comprehensive wallet analysis showing:
6784
osvm ovsm run examples/ovsm_scripts/mcp_wallet_analysis.ovsm
6885
```
6986

70-
### 3. Pumpfun 1-Minute Counter (`pumpfun_1min_lisp.ovsm`)
87+
### 4. Pumpfun 1-Minute Counter (`pumpfun_1min_lisp.ovsm`)
7188

7289
Production example counting Pumpfun transactions in the last minute:
7390
- Pagination with cursor-based fetching
@@ -79,9 +96,20 @@ Production example counting Pumpfun transactions in the last minute:
7996
osvm ovsm run examples/ovsm_scripts/pumpfun_1min_lisp.ovsm
8097
```
8198

82-
## Available MCP Tools
99+
## Complete Tool Documentation
100+
101+
**📖 See [MCP_TOOLS_REFERENCE.md](./MCP_TOOLS_REFERENCE.md) for complete documentation of all 75+ tools!**
102+
103+
The reference includes:
104+
- All 31 specialized osvm-mcp tools with examples
105+
- 90+ Solana RPC methods via `solana_rpc_call`
106+
- Parameter formats and return values
107+
- Best practices and troubleshooting
108+
- Complete code examples for each tool
109+
110+
## Quick Tool Overview
83111

84-
When osvm-mcp is running, these tools are available in OVSM scripts:
112+
When osvm-mcp is running, these tool categories are available:
85113

86114
### Basic RPC
87115
- `(getSlot)` - Get current slot

0 commit comments

Comments
 (0)