areev 0.2.0

Rust SDK for the Areev knowledge database — gRPC and HTTP transports
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

# Areev API Specifications

Canonical API contracts for [Areev](https://areev.ai) — the knowledge database for AI agents.

All SDK repos generate client code from these specs. **Do not edit manually** — specs are auto-synced from the Areev engine repo via CI.

## Structure

```
areev-specs/
├── proto/areev/v1/
│   ├── areev.proto          # gRPC service (AreevService — core data operations)
│   └── cluster.proto        # Distributed cluster RPCs (Raft + ClusterService)
├── openapi/
│   └── openapi.json         # REST API (OpenAPI 3.1.0, 50+ endpoints)
├── mcp/
│   └── mcp-manifest.json    # Model Context Protocol (14 tools, 3 resources)
├── a2a/
│   └── agent-card.json      # Agent-to-Agent (14 skills)
├── cal/
│   └── cal-capabilities.json # Context Assembly Language (15 statements, L2-Extended)
├── cli/
│   └── cli-commands.json    # CLI command structure
└── manifest.json            # Version + file index + generation timestamp
```

## Protocols

| Protocol | Spec File | Use Case |
|----------|-----------|----------|
| HTTP/REST | `openapi/openapi.json` | Universal API access |
| gRPC | `proto/areev/v1/areev.proto` | High-performance binary protocol |
| MCP | `mcp/mcp-manifest.json` | LLM/AI tool integration |
| A2A | `a2a/agent-card.json` | Agent-to-agent communication |
| CAL | `cal/cal-capabilities.json` | Context Assembly Language queries |

## SDK Repos

| Language | Repo | Package | Protocols |
|----------|------|---------|-----------|
| Rust | [areev-sdk-rust](https://github.com/AreevAI/areev-sdk-rust) | `areev-client` | gRPC, HTTP |
| TypeScript | [areev-sdk-typescript](https://github.com/AreevAI/areev-sdk-typescript) | `@areev/client` | HTTP, MCP, A2A |
| Python | [areev-sdk-python](https://github.com/AreevAI/areev-sdk-python) | `areev` | HTTP, gRPC, MCP |

## Versioning

Specs version matches the Areev engine version (`x.y.z`). Tags use `vX.Y.Z+BUILD` format:
- `x.y.z` increments on public releases
- `+BUILD` is the CI build number (internal tracking)

## Consuming Specs

**As a git submodule (recommended for Rust/internal):**
```bash
git submodule add git@github.com:AreevAI/areev-specs.git specs
```

**As a dependency in CI:**
```yaml
- uses: actions/checkout@v4
  with:
    repository: AreevAI/areev-specs
    path: specs
```

## License

BUSL-1.1 — See [LICENSE](LICENSE).