contextvm-sdk 0.1.1

Rust SDK for the ContextVM protocol — MCP over Nostr
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

---
title: Constants
description: A set of constants used throughout the @contextvm/sdk.
---

# Constants

The `@contextvm/sdk` exports a set of constants that are used throughout the library for event kinds, tags, and other protocol-specific values. These constants ensure consistency and alignment with the ContextVM specification.

## Event Kinds

The ContextVM protocol defines several Nostr event kinds for different types of messages.

| Constant                      | Kind  | Description                                                                   |
| ----------------------------- | ----- | ----------------------------------------------------------------------------- |
| `CTXVM_MESSAGES_KIND`         | 25910 | The kind for standard, ephemeral ContextVM messages.                          |
| `GIFT_WRAP_KIND`              | 1059  | The kind for encrypted messages, wrapped using the NIP-59 gift wrap standard. |
| `EPHEMERAL_GIFT_WRAP_KIND`    | 21059 | Ephemeral gift wrap kind for encrypted messages that relays should not store. |
| `SERVER_ANNOUNCEMENT_KIND`    | 11316 | A replaceable event for announcing a server's presence and basic info.        |
| `TOOLS_LIST_KIND`             | 11317 | A replaceable event for listing a server's available tools.                   |
| `RESOURCES_LIST_KIND`         | 11318 | A replaceable event for listing a server's available resources.               |
| `RESOURCETEMPLATES_LIST_KIND` | 11319 | A replaceable event for listing a server's available resource templates.      |
| `PROMPTS_LIST_KIND`           | 11320 | A replaceable event for listing a server's available prompts.                 |

## Nostr Tags

The SDK defines an object `NOSTR_TAGS` that contains constants for the various Nostr event tags used in the ContextVM protocol.

| Key                            | Tag                            | Description                                                            |
| ------------------------------ | ------------------------------ | ---------------------------------------------------------------------- |
| `PUBKEY`                       | `p`                            | The public key of the message recipient.                               |
| `EVENT_ID`                     | `e`                            | The event ID used to correlate requests and responses.                 |
| `CAPABILITY`                   | `cap`                          | A tag for specifying pricing metadata for a tool, resource, or prompt. |
| `NAME`                         | `name`                         | The human-readable name of a server in an announcement.                |
| `WEBSITE`                      | `website`                      | The URL of a server's website in an announcement.                      |
| `PICTURE`                      | `picture`                      | The URL of a server's icon in an announcement.                         |
| `ABOUT`                        | `about`                        | A tag for providing a short description of a server.                   |
| `SUPPORT_ENCRYPTION`           | `support_encryption`           | A tag indicating that a server supports end-to-end encryption.         |
| `SUPPORT_ENCRYPTION_EPHEMERAL` | `support_encryption_ephemeral` | A tag indicating support for ephemeral gift wraps (kind 21059).        |

## Announcement Methods

The `announcementMethods` object maps capability types to their corresponding MCP method names for server announcements.

```typescript
export const announcementMethods = {
  server: 'initialize',
  tools: 'tools/list',
  resources: 'resources/list',
  resourceTemplates: 'resources/templates/list',
  prompts: 'prompts/list',
} as const;
```

This object is used internally by the `NostrServerTransport` to construct announcement events.

## Timeout Configuration

| Constant             | Value | Description                                                                                                                   |
| -------------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------- |
| `DEFAULT_TIMEOUT_MS` | 30000 | Default timeout for network/relay operations (30 seconds). Used for encryption/decryption operations and connection timeouts. |

## Next Steps

With a solid understanding of the core modules, you are now ready to explore the **[Transports](/transports/base-nostr-transport)**, which are responsible for all network communication in the SDK.