zap-schema 1.0.0

ZAP Schema Compiler - Zero-Copy Application Protocol with whitespace-significant syntax
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

# ZAP Examples

This directory contains examples demonstrating ZAP usage across multiple languages.

## Schema Examples

### `schema/chat.zap`

A comprehensive real-time chat application schema demonstrating:
- Nested structs
- Enums
- Unions
- Interfaces with multiple methods
- Default values

```bash
# Compile the schema
zapc compile schema/chat.zap --out schema/chat.capnp

# Generate code for your language
zapc generate schema/chat.zap --lang rust --out ../rust/gen/
zapc generate schema/chat.zap --lang python --out ../python/gen/
zapc generate schema/chat.zap --lang ts --out ../typescript/gen/
zapc generate schema/chat.zap --lang go --out ../go/gen/
```

## Client Examples

Each language demonstrates the same core functionality:
- Connecting to a ZAP gateway
- Listing and calling tools
- Reading resources
- Getting prompts

### Rust

```bash
cd rust
cargo run
```

### Python

```bash
cd python
python main.py

# Additional examples
python main.py gateway    # Run a gateway
python main.py crypto     # Post-quantum crypto
python main.py identity   # Decentralized identity
python main.py consensus  # Agent consensus
```

### TypeScript

```bash
cd typescript
npx ts-node main.ts

# Additional examples
npx ts-node main.ts gateway    # Run a gateway
npx ts-node main.ts typed      # Typed tool calls
npx ts-node main.ts streaming  # Resource streaming
```

### Go

```bash
cd go
go run main.go

# Additional examples
go run main.go gateway  # Run a gateway
go run main.go typed    # Typed tool calls
```

## Running a Gateway

Before running the client examples, start a ZAP gateway:

```bash
# Using zapd (from the zap package)
zapd --config /path/to/config.toml

# Or with inline servers
zapd --server "stdio://npx @modelcontextprotocol/server-filesystem /tmp"
```

Example configuration (`config.toml`):

```toml
[gateway]
listen = "0.0.0.0"
port = 9999
log_level = "debug"

[[servers]]
name = "filesystem"
transport = "stdio"
command = "npx"
args = ["@modelcontextprotocol/server-filesystem", "/tmp"]

[[servers]]
name = "everything"
transport = "stdio"
command = "npx"
args = ["@modelcontextprotocol/server-everything"]
```

## Feature Demonstrations

### Post-Quantum Cryptography

All language examples include PQ crypto demonstrations:
- **ML-KEM-768** for key encapsulation
- **ML-DSA-65** for digital signatures
- **Hybrid mode** for defense in depth

### Decentralized Identity

W3C DID support examples:
- Generate `did:key` identifiers
- Sign and verify messages
- Create DID documents

### Agent Consensus

Multi-agent voting examples:
- Create consensus with configurable threshold
- Submit responses from multiple agents
- Finalize and check consensus

## Learn More

- [Main README](../README.md)
- [Documentation](https://zap-protocol.github.io/zap)
- [Schema Guide](https://zap-protocol.github.io/zap/docs/schema)