navi-plugin-api 0.3.7

Local agentic engine and terminal-first coding agent.
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

# navi-plugin-api

[![Crates.io](https://img.shields.io/crates/v/navi-plugin-api)](https://crates.io/crates/navi-plugin-api)
[![License](https://img.shields.io/crates/l/navi-plugin-api)](../LICENSE)

Stable plugin ABI for [NAVI](https://github.com/navi-ai-org/navi) — the trait definitions and types that plugin authors implement.

This crate is intentionally minimal: it has **no dependency on `navi-core`** and defines types used across the plugin boundary. Executable plugins run as **WASM** (`navi-plugin-runtime` / `navi-plugin-orchestrator`); native `libloading` plugins were removed (ADR 0013).

## Plugin ABI

```rust
use navi_plugin_api::{NaviPlugin, PluginRegistry, PluginTool, PluginToolDefinition, PluginToolKind};

struct MyPlugin;

impl NaviPlugin for MyPlugin {
    fn metadata(&self) -> PluginMetadata {
        PluginMetadata {
            name: "my-plugin".into(),
            version: "0.1.0".into(),
            api_version: NAVI_PLUGIN_API_VERSION,
            ..Default::default()
        }
    }

    fn register(&self, registry: &mut dyn PluginRegistry) -> Result<(), String> {
        registry.register_tool(Arc::new(MyTool));
        Ok(())
    }
}
```

## Key types

| Type | Description |
|------|-------------|
| `NaviPlugin` | Top-level plugin trait — metadata + tool registration |
| `PluginRegistry` | Registration interface for tools, policies, and components |
| `PluginTool` | Self-contained tool trait (definition + invoke) |
| `PluginToolDefinition` | Name, description, kind, and JSON schema |
| `PluginToolKind` | `Read`, `Write`, `Command`, or `Custom` |
| `PluginToolInvocation` | Invocation id, tool name, and JSON input |
| `PluginToolResult` | Invocation id, success flag, and JSON output |

## ABI versioning

The constant `NAVI_PLUGIN_API_VERSION` (currently `2`) is checked at load time. The host rejects plugins with incompatible versions.

## Writing a plugin

1. Depend on `navi-plugin-api` (not `navi-core`)
2. Implement `NaviPlugin` and one or more `PluginTool`s
3. Export `navi_plugin_entrypoint` as a `#[no_mangle]` function
4. Build as a `cdylib` (`.so` / `.dylib` / `.dll`)

```toml
[lib]
crate-type = ["cdylib"]
```

## Part of the NAVI workspace

**Full project:** <https://github.com/navi-ai-org/navi>
**License:** Apache-2.0