@@ -7,49 +7,50 @@ MCP server that lets AI agents search, inspect, and analyze [Substreams](https:/
77
88## Tools
99
10- ### ` search_substreams `
10+ ### Search Substreams
1111
12- Search the substreams.dev package registry.
12+ ` search_substreams ` : Search the substreams.dev package registry.
1313
1414| Parameter | Type | Default | Description |
15- | ----------- | ------ | --------- | ------------- |
15+ | --- | --- | --- | --- |
1616| ` query ` | string (required) | — | Search term, e.g. ` "solana dex" ` or ` "uniswap" ` |
1717| ` sort ` | string | ` "most_downloaded" ` | ` most_downloaded ` , ` alphabetical ` , ` most_used ` , ` last_uploaded ` |
1818| ` network ` | string | — | Filter by chain: ` ethereum ` , ` solana ` , ` arbitrum-one ` , etc. |
1919
2020Returns package name, URL, creator, network, version, published date, and download count.
2121
22- ### ` inspect_package `
22+ ### Inspect Package
2323
24- Inspect a Substreams package (.spkg) to see its full module graph, protobuf types, and metadata.
24+ ` inspect_package ` : Inspect a Substreams package (.spkg) to see its full module graph, protobuf types, and metadata.
2525
26- | Parameter | Type | Description |
27- | ----------- | ------| -------------|
28- | ` url ` | string (required) | Direct URL to a ` .spkg ` file |
26+ | Parameter | Type | Description |
27+ | --------- | -- --------------- | ---------------------------- |
28+ | ` url ` | string (required) | Direct URL to a ` .spkg ` file |
2929
3030Returns:
31+
3132- Package metadata (name, version, documentation, network)
3233- All modules with their kind (map/store/blockIndex), output types, and update policies
3334- Full DAG: each module's ` dependsOn ` and ` dependedBy ` relationships
3435- Input chain for each module (source blocks, other maps, stores with get/deltas mode, params)
3536- List of all protobuf output types and proto files
3637- Mermaid diagram of the module graph
3738
38- ### ` list_package_modules `
39+ ### List Package Modules
3940
40- Lightweight alternative to ` inspect_package ` — just the module names, types, and inputs/outputs.
41+ ` list_package_modules ` : Lightweight alternative to ` inspect_package ` — just the module names, types, and inputs/outputs.
4142
42- | Parameter | Type | Description |
43- | ----------- | ------| -------------|
44- | ` url ` | string (required) | Direct URL to a ` .spkg ` file |
43+ | Parameter | Type | Description |
44+ | --------- | -- --------------- | ---------------------------- |
45+ | ` url ` | string (required) | Direct URL to a ` .spkg ` file |
4546
46- ### ` get_sink_config `
47+ ### Get Sink Configuration
4748
48- Analyze a package's sink configuration and generate ready-to-run CLI commands.
49+ ` get_sink_config ` : Analyze a package's sink configuration and generate ready-to-run CLI commands.
4950
50- | Parameter | Type | Description |
51- | ----------- | ------| -------------|
52- | ` url ` | string (required) | Direct URL to a ` .spkg ` file |
51+ | Parameter | Type | Description |
52+ | --------- | -- --------------- | ---------------------------- |
53+ | ` url ` | string (required) | Direct URL to a ` .spkg ` file |
5354
5455Returns one of three results:
5556
@@ -74,7 +75,7 @@ get_sink_config("https://spkg.io/creator/package-v1.0.0.spkg")
7475
7576No installation needed:
7677
77- ### Claude Desktop / Cursor / Claude Code (stdio)
78+ ### Claude Desktop / Cursor / Claude Code
7879
7980Add to your MCP config (` claude_desktop_config.json ` , ` ~/.cursor/mcp.json ` , or ` ~/.claude/mcp.json ` ):
8081
@@ -118,11 +119,11 @@ Then point your agent at the SSE endpoint:
118119
119120### Transport Modes
120121
121- | Invocation | Transports | Use case |
122- | ---| ---| ---|
123- | ` npx substreams-search-mcp ` | stdio | Claude Desktop, Cursor, Claude Code |
124- | ` npx substreams-search-mcp --http ` | stdio + SSE :3849 | Dual — local + remote agents |
125- | ` npx substreams-search-mcp --http-only ` | SSE :3849 | OpenClaw, remote deployments |
122+ | Invocation | Transports | Use case |
123+ | --------------------------------------- | ----------------- | ----------------------------------- |
124+ | ` npx substreams-search-mcp ` | stdio | Claude Desktop, Cursor, Claude Code |
125+ | ` npx substreams-search-mcp --http ` | stdio + SSE :3849 | Dual — local + remote agents |
126+ | ` npx substreams-search-mcp --http-only ` | SSE :3849 | OpenClaw, remote deployments |
126127
127128A ` /health ` endpoint is available at ` http://localhost:3849/health ` when HTTP transport is active.
128129
@@ -134,4 +135,4 @@ A `/health` endpoint is available at `http://localhost:3849/health` when HTTP tr
134135
135136## Acknowledgments
136137
137- Thanks for PaulieB for creating the [ Substreams Search MCP] ( https://github.com/PaulieB14/substreams-search-mcp )
138+ Thanks for PaulieB for creating the [ Substreams Search MCP] ( https://github.com/PaulieB14/substreams-search-mcp )
0 commit comments