reference

title	Reference Documentation
description	Technical reference for APIs, configuration, protocols, and database schemas
category	reference
difficulty-level	intermediate
tags	reference api configuration protocols database
updated-date	2025-01-29

VisionClaw Reference Documentation

Complete technical reference documentation for VisionClaw APIs, protocols, configurations, database schemas, and error codes.

---

Reference Sections

Section	Description
REST API	All REST endpoints with request/response schemas
WebSocket Binary Protocol	V2/V3/V4 binary protocol specification
Neo4j Schema	Unified graph database schema across all bounded contexts
Agents Catalog	All 54 agent skills with invocation patterns
Configuration	Environment variables, Docker Compose options
Protocol Reference	MCP protocol, skill classification
CLI Reference	Cargo and Docker command reference
Error Codes	Complete error code reference with solutions
Glossary	Technical term definitions

---

Quick Access

API Reference

Document	Description
REST API	All REST endpoints — Nostr NIP-98 auth, graph, settings, ontology, Solid
WebSocket Binary Protocol	V2 (36-byte), V3 analytics, V4 compact — V1 JSON is removed

Configuration

Document	Description
Environment Variables	All env var options
Docker Compose	Container configuration

Protocols

Document	Description
Binary WebSocket	V2/V3/V4 wire formats
MCP Protocol	Agent orchestration protocol

Database

Document	Description
Neo4j Schema (Unified)	Graph database schema including ontology storage

CLI

Document	Description
Cargo Commands	Rust build, test, run
Docker Commands	Docker Compose commands

---

Additional Documentation

Specialized References

Document	Description
Performance Benchmarks	Performance metrics and targets
Implementation Status	Feature implementation status (see main README)
Code Quality	Code quality metrics (see main README)

API Deep Dives

Document	Description
REST API	All REST endpoints including pathfinding, semantic features, and Solid pod integration

---

Documentation Standards

Frontmatter Format

All reference documents use standardised frontmatter:

---
title: Document Title
description: Brief description
category: reference
difficulty-level: intermediate
updated-date: 2025-01-29
---

Difficulty Levels

Level	Audience
beginner	New users
intermediate	Experienced users
advanced	System architects, contributors

---

Related Documentation

Guides

• Configuration Guide - Practical examples
• Deployment Guide - Production deployment
• Troubleshooting Guide - Common issues

Concepts

• Architecture Overview - System architecture
• Data Flow - Data flow diagrams

Getting Started

• Installation Guide - Setup instructions
• First Graph - Quick start tutorial

---

Last Updated: January 29, 2025