Avp Ts

Overview

avp-ts is the official TypeScript implementation of the Agent Vault Protocol (AVP). It runs in Node.js, browsers, and edge runtimes, with native MCP (Model Context Protocol) support.

Features

• Standard AVP Conformance — All 7 core operations
• Universal — Node.js, browsers, Deno, Bun, Cloudflare Workers
• MCP Native — First-class Model Context Protocol support
• Type Safe — Full TypeScript types, zero any
• Tree Shakeable — Import only what you need

Installation

npm install @avp-protocol/avp
# or
yarn add @avp-protocol/avp
# or
pnpm add @avp-protocol/avp

Quick Start

import { Vault } from '@avp-protocol/avp';

// Create vault instance
const vault = new Vault('avp.toml');

// Authenticate
await vault.authenticate();

// Store a secret
await vault.store('anthropic_api_key', 'sk-ant-...');

// Retrieve a secret
const apiKey = await vault.retrieve('anthropic_api_key');

Backend Selection

import { Vault, FileBackend, KeychainBackend, RemoteBackend } from '@avp-protocol/avp';

// File backend (encrypted)
const vault = new Vault({
  backend: new FileBackend({
    path: '~/.avp/secrets.enc',
    cipher: 'aes-256-gcm'
  })
});

// OS Keychain (Node.js only)
const vault = new Vault({
  backend: new KeychainBackend()
});

// Remote vault
const vault = new Vault({
  backend: new RemoteBackend({
    url: 'https://vault.company.com',
    token: 'hvs.xxx'
  })
});

MCP Integration

AVP-TS includes a built-in MCP server for AI agents:

import { createMCPServer } from '@avp-protocol/avp/mcp';

// Create MCP server with AVP tools
const server = createMCPServer({
  config: 'avp.toml'
});

// Tools exposed:
// - avp_discover
// - avp_authenticate
// - avp_store
// - avp_retrieve
// - avp_delete
// - avp_list
// - avp_rotate

Use with Claude, ChatGPT, or any MCP-compatible agent:

{
  "mcpServers": {
    "avp": {
      "command": "npx",
      "args": ["@avp-protocol/avp-mcp"]
    }
  }
}

Browser Usage

import { Vault, MemoryBackend } from '@avp-protocol/avp/browser';

// Browser-safe in-memory backend
const vault = new Vault({
  backend: new MemoryBackend()
});

// Or connect to remote vault
const vault = new Vault({
  backend: new RemoteBackend({
    url: 'https://vault.company.com'
  })
});

Migration

import { migrate } from '@avp-protocol/avp';

// Migrate from file to keychain
await migrate({
  source: new FileBackend({ path: '~/.avp/secrets.enc' }),
  target: new KeychainBackend()
});

API Reference

Vault

Conformance

Contributing

See CONTRIBUTING.md for development setup.

License

Apache 2.0 — see LICENSE.