Skip to content
Draft
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ config.json
*.tgz
cache
.claude
/src/generated/
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,33 @@ interface {
}
```

### Introspection

The server supports introspection commands that allow clients to discover the API at runtime. These commands work both before and after `initialize`, so clients can explore the API at any point — including before negotiating a schema version.

#### Get command schema

Returns the full [JSON Schema](https://json-schema.org/) describing all incoming message types. The schema uses `$ref` pointers and a shared `definitions` dictionary for compact representation.

```ts
interface {
messageId: string;
command: "introspect.commands";
}
```

Returns a JSON Schema (Draft 7) object describing all valid incoming messages.

**Exploring the schema**

The returned schema can be explored with any JSON Schema-compatible tool:

- **[jq](https://jqlang.org/)** — Query the schema from the command line (e.g. `jq '.definitions.IncomingMessageNode'`)
- **[JSON Schema Viewer](https://json-schema.app/)** — Paste the schema into the online viewer for interactive exploration
- **[JSON Crack](https://jsoncrack.com/)** — Visualize the schema as an interactive graph
- **VS Code** — Extensions like [JSON Schema Viewer](https://marketplace.visualstudio.com/items?itemName=jock.svg) provide in-editor navigation
- **[jsonschema](https://python-jsonschema.readthedocs.io/) (Python)** / **[ajv](https://ajv.js.org/) (JS)** — Validate messages programmatically against the schema

### Driver level commands

#### Get the config of the driver
Expand Down
Loading