Skip to content
This repository was archived by the owner on Jul 21, 2025. It is now read-only.

Commit e105f29

Browse files
committed
docs: update readme
1 parent ed16462 commit e105f29

2 files changed

Lines changed: 48 additions & 26 deletions

File tree

README.md

Lines changed: 43 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,66 @@
11
# DVMCP: Data Vending Machine Context Protocol
2-
A monorepo containing packages that bridge Model Context Protocol (MCP) servers with Nostr's Data Vending Machine (DVM) ecosystem, enabling AI and computational tools to be discovered and utilized via Nostr's decentralized network.
2+
3+
DVMCP (Data Vending Machine Context Protocol) is a project that bridges the Model Context Protocol (MCP) with Nostr's Data Vending Machine (DVM) ecosystem. It enables AI and computational services running on MCP servers to be seamlessly discovered, accessed, and utilized via the decentralized Nostr network.
4+
5+
This integration combines MCP's standardized capability framework with Nostr's cryptographically secure and decentralized messaging, offering key advantages:
6+
7+
* **Discoverability**: MCP servers and their capabilities can be found through the Nostr network without centralized registries.
8+
* **Verifiability**: Messages are cryptographically signed, ensuring authenticity and integrity.
9+
* **Decentralization**: No single point of failure for service discovery or communication.
10+
* **Protocol Interoperability**: Both MCP and DVMs leverage JSON-RPC patterns, facilitating smooth communication.
11+
12+
For a detailed technical specification, refer to the [DVMCP Specification (2025-03-26)](./docs/dvmcp-spec-2025-03-26.md).
13+
14+
## Event Kinds
15+
16+
The following Nostr event kinds are defined and used within the DVMCP:
17+
18+
| Kind | Description |
19+
| ----- | ------------------------------------- |
20+
| 31316 | Server Announcement |
21+
| 31317 | Tools List |
22+
| 31318 | Resources List |
23+
| 31319 | Prompts List |
24+
| 25910 | Requests |
25+
| 26910 | Responses |
26+
| 21316 | Feedback/Notifications |
27+
| 1059 | Encrypted Messages (NIP-59 Gift Wrap) |
28+
329
## Packages
30+
431
This monorepo contains the following packages:
32+
533
### [@dvmcp/bridge](./packages/dvmcp-bridge)
34+
635
The bridge implementation that connects MCP servers to Nostr's DVM ecosystem. Handles tool announcement, execution, and status updates.
36+
737
### [@dvmcp/discovery](./packages/dvmcp-discovery)
38+
839
A MCP server/discovery service that aggregates MCP tools from DVMs and makes their tools available.
40+
941
### [@dvmcp/commons](./packages/dvmcp-commons)
42+
1043
Shared utilities and components used across DVMCP packages.
44+
1145
## Installation & Usage
46+
1247
**Prerequisite:** Ensure you have [Bun](https://bun.sh/) installed.
1348

1449
### Quick Start with Bunx (No Installation)
50+
1551
You can run the packages directly using `bunx` without installing them:
52+
1653
```bash
1754
# Run the bridge
1855
bunx dvmcp-bridge
1956
# Run the discovery service
2057
bunx dvmcp-discovery
2158
```
59+
2260
The interactive CLI will guide you through configuration setup on first run.
2361

2462
### Global Installation
63+
2564
```bash
2665
# Install the packages globally
2766
bun install -g @dvmcp/bridge @dvmcp/discovery
@@ -30,26 +69,10 @@ dvmcp-bridge
3069
dvmcp-discovery
3170
```
3271

33-
## Setting Up a Bridge
34-
To expose your MCP server as a DVM on Nostr:
35-
1. Navigate to the directory where you want to configure the bridge
36-
2. Run: `bunx dvmcp-bridge`
37-
3. Follow the interactive setup to configure:
38-
- Your MCP server path
39-
- Nostr private key (or generate a new one)
40-
- Relays to connect to
41-
4. The bridge will start and begin proxying requests between Nostr and your MCP server
42-
43-
## Setting Up a Discovery Service
44-
To aggregate MCP tools from DVMs:
45-
1. Navigate to your desired directory
46-
2. Run: `bunx dvmcp-discovery`
47-
3. Follow the setup to configure:
48-
- Nostr private key
49-
- Relays to monitor
50-
5172
## Development
73+
5274
For contributors to this repository:
75+
5376
```bash
5477
# Clone the repo
5578
git clone https://github.com/gzuuus/dvmcp.git
@@ -59,5 +82,4 @@ bun install
5982
# Start the bridge in development mode
6083
bun run dev --cwd packages/dvmcp-bridge
6184
# Start the discovery service in development mode
62-
bun run dev --cwd packages/dvmcp-discovery
63-
```
85+
bun run dev --cwd packages/dvmcp-discovery

packages/dvmcp-bridge/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ A bridge implementation that connects Model Context Protocol (MCP) servers to No
55
## Features
66

77
- Connect and manage multiple MCP servers through a single DVM instance
8-
- Automatic service announcement using NIP-89
9-
- Tool discovery and execution through DVM kind:5910/6910 events
10-
- Job status updates and payment handling via kind:7000 events
11-
- Service announcement deletion using NIP-09
12-
- Encrypted communication support using NIP-17/NIP-59
8+
- Automatic service announcement
9+
- Tool discovery and execution
10+
- Job status updates and payment handling
11+
- Service announcement deletion
12+
- Encrypted communication support
1313
- Comprehensive error handling
1414

1515
## Configuration

0 commit comments

Comments
 (0)