Skip to content
This repository was archived by the owner on Jul 21, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .changeset/grumpy-rats-spend.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ jobs:
run: bun test

- name: Check formatting
run: bun run format --check
run: bun run fmt --check
42 changes: 17 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,39 +11,43 @@ Shared utilities and components used across DVMCP packages.
## Installation & Usage
**Prerequisite:** Ensure you have [Bun](https://bun.sh/) installed.

### Quick Start with NPX (No Installation)
You can run the packages directly using `npx` without installing them:
### Quick Start with Bunx (No Installation)
You can run the packages directly using `bunx` without installing them:
```bash
# Run the bridge
npx @dvmcp/bridge
bunx dvmcp-bridge
# Run the discovery service
npx @dvmcp/discovery
bunx dvmcp-discovery
```
The interactive CLI will guide you through configuration setup on first run.

### Global Installation
```bash
# Install the packages globally
npm install -g @dvmcp/bridge @dvmcp/discovery
bun install -g @dvmcp/bridge @dvmcp/discovery
# Run the commands
dvmcp-bridge
dvmcp-discovery
```

## Setting Up a Bridge
To expose your MCP server as a DVM on Nostr:
1. Navigate to the directory where you want to configure the bridge
2. Run: `npx @dvmcp/bridge`
2. Run: `bunx dvmcp-bridge`
3. Follow the interactive setup to configure:
- Your MCP server path
- Nostr private key (or generate a new one)
- Relays to connect to
- Your MCP server path
- Nostr private key (or generate a new one)
- Relays to connect to
4. The bridge will start and begin proxying requests between Nostr and your MCP server

## Setting Up a Discovery Service
To aggregate MCP tools from DVMs:
1. Navigate to your desired directory
2. Run: `npx @dvmcp/discovery`
2. Run: `bunx dvmcp-discovery`
3. Follow the setup to configure:
- Nostr private key
- Relays to monitor
- Nostr private key
- Relays to monitor

## Development
For contributors to this repository:
```bash
Expand All @@ -56,16 +60,4 @@ bun install
bun run dev --cwd packages/dvmcp-bridge
# Start the discovery service in development mode
bun run dev --cwd packages/dvmcp-discovery
```
## Documentation
- [DVMCP Specification](./docs/dvmcp-spec.md)
- [Bridge Package](./packages/dvmcp-bridge/README.md)
- [Discovery Package](./packages/dvmcp-discovery/README.md)
- [Commons Package](./packages/dvmcp-commons/README.md)
## Contributing
Contributions are welcome! Please feel free to submit pull requests or create issues.
## License
[MIT License](LICENSE)
## Related Projects
- [Model Context Protocol](https://modelcontextprotocol.io)
- [Nostr Protocol](https://github.com/nostr-protocol/nips)
```
15 changes: 8 additions & 7 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
- [x] Add flag `--config-path` to cli
- [x] Add one command, configless, quick run mode in discovery package
- [ ] Review for 2025-03-26
- [ ] Add payments (#10)
- [ ] Add env variables(#7)
- [ ] Add resources to bridge package
- [ ] Add sessions
- [ ] Add encryption
- [ ] Discovery cli to bootstrap configuration
- [x] Review for 2025-03-26
- [x] Add payments (#10)
- [x] Add env variables(#7)
- [x] Add resources to bridge package
- [x] Add encryption
- [x] Discovery cli to bootstrap configuration
- [ ] Unannounced/Private servers
- [ ] Improve docs
11 changes: 5 additions & 6 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading