symbiont-sdk-js

分类: 开发与编程 | 上传者: ThirdKeyAI | 下载: 0 | 版本: v1.0（最新）

TypeScript SDK for the Symbiont agent runtime — agent lifecycle, webhook verification, AgentPin identity, memory systems, skill scanning, metrics, scheduling, and MCP integration

更新日志: Source: GitHub https://github.com/ThirdKeyAI/symbiont-sdk-js

目录结构

当前层级: 根目录

📁 apps/
- 📁 docs/
  - 📁 guides/
    
    📄 agent-management.md 17.0 KB
    
    📄 getting-started.md 9.3 KB
    
    📄 policy-creation.md 23.2 KB
    
    📄 secrets-management.md 20.4 KB
    
    📄 tool-review-workflow.md 23.0 KB
  - 📄 README.md 2.0 KB
📁 packages/
- 📁 agent/
  - 📁 src/
    
    📁 __tests__/
    
    📄 AgentClient.integration.test.ts 8.5 KB
    
    📄 ChannelClient.integration.test.ts 13.0 KB
    
    📄 ScheduleClient.integration.test.ts 11.5 KB
    
    📄 AgentClient.ts 5.0 KB
    
    📄 AgentPinClient.ts 7.7 KB
    
    📄 ChannelClient.ts 6.5 KB
    
    📄 index.ts 1.7 KB
    
    📄 ScheduleClient.ts 5.9 KB
    
    📄 WorkflowClient.ts 2.4 KB
  - 📄 package.json 980 B
  - 📄 rollup.config.js 656 B
  - 📄 tsconfig.json 313 B
- 📁 cli/
  - 📁 src/
    
    📁 commands/
    
    📄 agent.ts 11.3 KB
    
    📄 auth.ts 6.5 KB
    
    📄 dev.ts 9.8 KB
    
    📁 utils/
    
    📄 config.ts 3.9 KB
    
    📄 error-handler.ts 1.7 KB
    
    📄 output.ts 3.7 KB
    
    📄 cli.ts 1.3 KB
    
    📄 index.ts 509 B
  - 📄 package.json 1.2 KB
  - 📄 rollup.config.js 1.5 KB
  - 📄 tsconfig.json 340 B
- 📁 core/
  - 📁 src/
    
    📁 __tests__/
    
    📄 AuthenticationManager.test.ts 11.5 KB
    
    📄 MarkdownMemoryStore.test.ts 3.3 KB
    
    📄 MetricsClient.test.ts 5.3 KB
    
    📄 ReasoningClient.test.ts 15.2 KB
    
    📄 SkillScanner.test.ts 6.5 KB
    
    📄 SymbiontClient.test.ts 9.3 KB
    
    📄 WebhookVerifier.test.ts 3.1 KB
    
    📁 auth/
    
    📁 __tests__/
    
    📄 JWTHandler.test.ts 11.6 KB
    
    📄 RBACManager.test.ts 15.0 KB
    
    📄 SecurityUtils.test.ts 16.5 KB
    
    📄 AuthManager.ts 8.8 KB
    
    📄 index.ts 410 B
    
    📄 JWTHandler.ts 4.8 KB
    
    📄 RBACManager.ts 6.0 KB
    
    📄 SecurityUtils.ts 3.5 KB
    
    📄 TokenValidator.ts 4.1 KB
    
    📁 config/
    
    📁 __tests__/
    
    📄 AuthConfig.test.ts 15.6 KB
    
    📄 ClientConfig.test.ts 13.4 KB
    
    📄 EnvManager.test.ts 17.4 KB
    
    📄 AuthConfig.ts 2.8 KB
    
    📄 ClientConfig.ts 2.0 KB
    
    📄 DatabaseConfig.ts 4.3 KB
    
    📄 EnvManager.ts 11.7 KB
    
    📄 index.ts 190 B
    
    📄 LoggingConfig.ts 5.5 KB
    
    📄 VectorConfig.ts 4.5 KB
    
    📁 http/
    
    📁 __tests__/
    
    📄 EndpointMetrics.test.ts 12.8 KB
    
    📄 HttpEndpointManager.test.ts 26.1 KB
    
    📄 EndpointMetrics.ts 4.7 KB
    
    📄 HttpEndpointManager.ts 13.7 KB
    
    📄 index.ts 208 B
    
    📁 memory/
    
    📁 __tests__/
    
    📄 HierarchicalMemory.test.ts 16.6 KB
    
    📄 InMemoryStore.test.ts 21.7 KB
    
    📄 MemoryManager.test.ts 20.9 KB
    
    📄 HierarchicalMemory.ts 9.9 KB
    
    📄 index.ts 552 B
    
    📄 InMemoryStore.ts 8.6 KB
    
    📄 MemoryManager.ts 8.5 KB
    
    📄 MemoryStore.ts 3.5 KB
    
    📁 security/
    
    📁 __tests__/
    
    📄 CryptoUtils.test.ts 14.9 KB
    
    📄 InputValidator.test.ts 20.2 KB
    
    📄 SecureLogger.test.ts 16.9 KB
    
    📄 security.test.ts 8.6 KB
    
    📄 SecurityManager.test.ts 18.0 KB
    
    📄 CryptoUtils.ts 8.4 KB
    
    📄 index.ts 684 B
    
    📄 InputValidator.ts 13.1 KB
    
    📄 SecureLogger.ts 11.1 KB
    
    📄 SecurityConfig.ts 5.2 KB
    
    📄 SecurityManager.ts 5.8 KB
    
    📄 SecurityUtils.ts 3.6 KB
    
    📁 vector/
    
    📁 qdrant/
    
    📁 __tests__/
    
    📄 CollectionManager.test.ts 16.5 KB
    
    📄 EmbeddingManager.test.ts 21.5 KB
    
    📄 QdrantManager.test.ts 13.6 KB
    
    📄 SearchEngine.test.ts 20.5 KB
    
    📄 VectorOperations.test.ts 18.9 KB
    
    📄 CollectionManager.ts 7.8 KB
    
    📄 EmbeddingManager.ts 11.1 KB
    
    📄 index.ts 323 B
    
    📄 QdrantManager.ts 6.5 KB
    
    📄 SearchEngine.ts 10.4 KB
    
    📄 VectorOperations.ts 9.4 KB
    
    📄 index.ts 478 B
    
    📄 auth.ts 5.3 KB
    
    📄 client.ts 16.5 KB
    
    📄 index.ts 1.7 KB
    
    📄 MarkdownMemoryStore.ts 6.2 KB
    
    📄 MetricsClient.ts 7.2 KB
    
    📄 ReasoningClient.ts 7.6 KB
    
    📄 SkillScanner.ts 8.1 KB
    
    📄 SystemClient.ts 2.3 KB
    
    📄 WebhookVerifier.ts 4.6 KB
  - 📄 package.json 1.2 KB
  - 📄 rollup.config.js 881 B
  - 📄 tsconfig.json 340 B
- 📁 mcp/
  - 📁 src/
    
    📁 __tests__/
    
    📄 McpClient.integration.test.ts 22.5 KB
    
    📄 index.ts 318 B
    
    📄 McpClient.ts 4.4 KB
  - 📄 package.json 990 B
  - 📄 rollup.config.js 656 B
  - 📄 tsconfig.json 340 B
- 📁 policy/
  - 📁 src/
    
    📄 index.ts 505 B
    
    📄 PolicyBuilder.ts 8.6 KB
  - 📄 package.json 958 B
  - 📄 rollup.config.js 656 B
  - 📄 tsconfig.json 340 B
- 📁 secrets/
  - 📁 src/
    
    📁 __tests__/
    
    📁 providers/
    
    📄 EnvironmentVariableProvider.test.ts 8.3 KB
    
    📄 SecretManager.test.ts 13.1 KB
    
    📁 providers/
    
    📄 EnvironmentVariableProvider.ts 1.5 KB
    
    📄 FileProvider.ts 4.9 KB
    
    📄 VaultProvider.ts 1.3 KB
    
    📄 index.ts 712 B
    
    📄 SecretManager.ts 7.8 KB
  - 📄 package.json 961 B
  - 📄 rollup.config.js 670 B
  - 📄 tsconfig.json 340 B
- 📁 testing/
  - 📁 src/
    
    📁 data/
    
    📄 mockData.ts 8.8 KB
    
    📁 helpers/
    
    📄 testHelpers.ts 6.3 KB
    
    📁 mocks/
    
    📄 MockAuthManager.ts 2.5 KB
    
    📄 MockFetch.ts 4.6 KB
    
    📄 MockSecretManager.ts 4.4 KB
    
    📄 index.ts 357 B
    
    📄 TestEnvironment.ts 4.2 KB
  - 📄 package.json 933 B
  - 📄 rollup.config.js 677 B
  - 📄 tsconfig.json 340 B
- 📁 tool-review/
  - 📁 src/
    
    📁 __tests__/
    
    📄 ToolReviewClient.integration.test.ts 21.4 KB
    
    📄 index.ts 577 B
    
    📄 ToolReviewClient.ts 7.3 KB
  - 📄 package.json 958 B
  - 📄 rollup.config.js 656 B
  - 📄 tsconfig.json 340 B
- 📁 types/
  - 📁 src/
    
    📄 agent.ts 4.6 KB
    
    📄 agentpin.ts 2.1 KB
    
    📄 auth.ts 2.7 KB
    
    📄 channel.ts 4.5 KB
    
    📄 config.ts 15.7 KB
    
    📄 http.ts 6.7 KB
    
    📄 index.ts 1.6 KB
    
    📄 mcp.ts 3.6 KB
    
    📄 memory.ts 5.3 KB
    
    📄 metrics.ts 3.6 KB
    
    📄 policy.ts 4.4 KB
    
    📄 reasoning.ts 12.2 KB
    
    📄 schedule.ts 4.8 KB
    
    📄 secrets.ts 3.5 KB
    
    📄 skills.ts 3.5 KB
    
    📄 system.ts 1.1 KB
    
    📄 tool-review.ts 6.8 KB
    
    📄 vector.ts 7.1 KB
    
    📄 webhook.ts 1.2 KB
  - 📄 package.json 999 B
  - 📄 rollup.config.js 782 B
  - 📄 tsconfig.json 262 B
📄 .gitignore 2.2 KB
📄 ARCHITECTURE.md 21.1 KB
📄 CHANGELOG.md 12.0 KB
📄 context7.json 2.0 KB
📄 debug-security.js 4.2 KB
📄 eslint.config.js 1.4 KB
📄 IMPLEMENTATION_GUIDE.md 11.6 KB
📄 LICENSE 10.5 KB
📄 package-lock.json 311.6 KB
📄 package.json 1.4 KB
📄 README.md 13.4 KB
📄 SKILL.md 10.8 KB
📄 test-config.js 3.2 KB
📄 tsconfig.json 867 B
📄 typedoc.json 1.9 KB
📄 update-plan.md 16.3 KB
📄 vitest.config.ts 1.1 KB

SKILL.md

---
name: symbiont-sdk-js
title: Symbiont SDK for JavaScript/TypeScript
description: TypeScript SDK for the Symbiont agent runtime — agent lifecycle, webhook verification, AgentPin identity, memory systems, skill scanning, metrics, scheduling, and MCP integration
version: 0.6.0
---

# Symbiont SDK for JavaScript/TypeScript — Skills Guide

**Purpose**: This guide helps AI assistants quickly build applications using the Symbiont JavaScript/TypeScript SDK.

**For Full Documentation**: See the [README](https://github.com/ThirdKeyAI/symbiont-sdk-js/blob/main/README.md).

## What This SDK Does

The Symbiont JS/TS SDK (`@symbi/core`) provides a client for interacting with the Symbiont agent runtime. It covers agent lifecycle management, policy enforcement, secrets management, MCP protocol integration, memory systems, AgentPin credential verification, webhook signature verification, agent skill scanning, and metrics collection/export.

**Part of the ThirdKey trust stack**: SchemaPin (tool integrity) → AgentPin (agent identity) → Symbiont (runtime)

---

## Quick Start

```bash
npm install @symbi/core
```

```typescript
import { SymbiontClient } from '@symbi/core';

const client = new SymbiontClient({
    apiKey: process.env.SYMBIONT_API_KEY,
    environment: 'production',
});
```

---

## Core APIs

### Agent Management (`client.agents`)

```typescript
// List agents
const agents = await client.agents.listAgents();

// Create an agent
const agent = await client.agents.createAgent({
    name: 'my-agent',
    description: 'A helpful agent',
    capabilities: ['read', 'write'],
});

// Execute an agent
const result = await client.agents.executeAgent(agent.id, {
    input: 'process this data',
});

// Check status
const status = await client.agents.getAgentStatus(agent.id);
```

### AgentPin Integration (`client.agentpin`)

Cryptographic agent identity verification:

```typescript
// Generate P-256 keypair
const { privateKeyPem, publicKeyPem, publicKeyJwk } = client.agentpin.generateKeyPair();

// Issue a JWT credential
const jwt = client.agentpin.issueCredential({
    privateKeyPem,
    kid: 'key-1',
    issuer: 'https://example.com',
    agentId: 'my-agent',
    capabilities: ['read', 'write'],
});

// Verify credential (online)
const result = await client.agentpin.verifyCredential(jwt);

// Verify credential (offline with local discovery)
const result = client.agentpin.verifyCredentialOffline(jwt, discoveryDoc);

// Verify with trust bundle
const result = client.agentpin.verifyCredentialWithBundle(jwt, bundle);

// Fetch discovery document
const doc = await client.agentpin.fetchDiscoveryDocument('example.com');

// Trust management
const bundle = client.agentpin.createTrustBundle();
const pinStore = client.agentpin.createPinStore();
```

### Webhook Verification

Verify inbound webhook signatures from GitHub, Stripe, Slack, or custom providers:

```typescript
import {
    HmacVerifier, JwtVerifier, createProviderVerifier, WebhookProviderPresets,
} from '@symbi/core';

// Use a provider preset (GitHub, Stripe, Slack, Custom)
const verifier = createProviderVerifier('GITHUB', Buffer.from(secret));
verifier.verify(request.headers, Buffer.from(request.body));

// Manual HMAC verifier with prefix stripping
const hmac = new HmacVerifier(
    Buffer.from(secret), 'X-Hub-Signature-256', 'sha256='
);
hmac.verify(headers, body);

// JWT-based webhook verification
const jwt = new JwtVerifier(
    Buffer.from(secret), 'Authorization', 'expected-issuer'
);
jwt.verify(headers, body);
```

### Markdown Memory Persistence

File-based agent context persistence using markdown format:

```typescript
import { MarkdownMemoryStore } from '@symbi/core';

const store = new MarkdownMemoryStore('/data/memory', 30); // 30-day retention

// Save agent context
await store.saveContext('agent-1', {
    agentId: 'agent-1',
    facts: ['User prefers dark mode', 'Timezone is UTC-5'],
    procedures: ['Always greet by name'],
    learnedPatterns: ['Responds better to bullet points'],
    metadata: { lastSession: '2026-02-15' },
});

// Load context
const context = await store.loadContext('agent-1');

// List all agents with stored contexts
const agents = await store.listAgentContexts();

// Compact old daily logs
await store.compact('agent-1');

// Storage statistics
const stats = await store.getStorageStats();
```

### Agent Skills (ClawHavoc Scanning + Loading)

Scan and load agent skill definitions with security scanning:

```typescript
import { SkillScanner, SkillLoader } from '@symbi/core';

// Scan content for security issues (10 built-in ClawHavoc rules)
const scanner = new SkillScanner();
const findings = scanner.scanContent(skillContent, 'SKILL.md');
// Detects: pipe-to-shell, wget-pipe-to-shell, env file references,
//   SOUL.md/memory.md tampering, eval+fetch, base64-decode-exec, rm-rf, chmod-777

// Scan an entire skill directory
const result = scanner.scanSkill('/path/to/skill');

// Load skills from configured paths
const loader = new SkillLoader({
    loadPaths: ['/skills/verified', '/skills/community'],
    requireSigned: false,
    scanEnabled: true,
});
const skills = loader.loadAll();

// Load a single skill (reads SKILL.md, parses frontmatter, scans)
const skill = loader.loadSkill('/path/to/skill');
console.log(skill.name, skill.signatureStatus, skill.scanResult);
```

### Metrics Collection & Export (`client.metricsClient`)

Runtime metrics retrieval and local export:

```typescript
import {
    MetricsApiClient, FileMetricsExporter, CompositeExporter, MetricsCollector,
} from '@symbi/core';

// Fetch metrics from runtime API (via client)
const snapshot = await client.metricsClient.getSnapshot();
const scheduler = await client.metricsClient.getSchedulerMetrics();
const system = await client.metricsClient.getSystemMetrics();
await client.metricsClient.exportMetrics({ format: 'json' });

// Export metrics to file (atomic JSON write)
const fileExporter = new FileMetricsExporter({ filePath: '/tmp/metrics.json' });
await fileExporter.export(snapshot);

// Fan-out to multiple backends
const composite = new CompositeExporter([fileExporter, otherExporter]);
await composite.export(snapshot);

// Periodic background collection
const collector = new MetricsCollector(composite, 60000); // every 60s
collector.start(fetchSnapshotFn);
collector.stop();
```

### Memory System

Hierarchical memory with short-term, long-term, episodic, and semantic levels:

```typescript
import { MemoryManager, InMemoryStore, HierarchicalMemory } from '@symbi/core';

const memory = new HierarchicalMemory();
await memory.store({ content: 'data', level: 'short-term' });
const results = await memory.search('query');
```

### Scheduling (`client.schedules`)

```typescript
const schedule = await client.schedules.create({
    agentId: 'my-agent',
    cron: '0 */6 * * *',
    parameters: { task: 'cleanup' },
});

const schedules = await client.schedules.list();
const health = await client.schedules.getSchedulerHealth();
```

### Policy Management (`client.policies`)

```typescript
import { PolicyBuilder } from '@symbi/core';

const policy = new PolicyBuilder()
    .allow(['read_data', 'write_output'])
    .deny(['execute_code', 'network_access'])
    .require({ inputValidation: true })
    .build();
```

### Secrets Management (`client.secrets`)

Supports Vault, file-based, and environment variable providers:

```typescript
const secret = await client.secrets.get('api-key');
await client.secrets.set('api-key', 'value');
```

### MCP Protocol (`client.mcp`)

```typescript
const tools = await client.mcp.listTools();
const result = await client.mcp.invokeTool('tool-name', { param: 'value' });
```

### Tool Review (`client.toolReview`)

```typescript
const review = await client.toolReview.submitForReview(toolInvocation);
const status = await client.toolReview.getReviewStatus(reviewId);
```

### HTTP Endpoints (`client.http`)

Manage HTTP input endpoints for agent invocation.

---

## Package Structure

| Package | Purpose |
|---------|---------|
| `@symbi/core` | Main client, configuration, types, webhook verification, skills, metrics, memory |
| `@symbi/agent` | Agent management, schedules, channels, workflows, AgentPin |
| `@symbi/types` | Shared TypeScript interfaces and Zod schemas |
| `@symbi/policy` | Policy builder and enforcement |
| `@symbi/secrets` | Secrets management providers |
| `@symbi/mcp` | MCP protocol client |
| `@symbi/tool-review` | Tool review workflow |

---

## Sub-Clients

| Client | Access | Purpose |
|--------|--------|---------|
| `client.agents` | Lazy-loaded | Agent lifecycle management |
| `client.agentpin` | Lazy-loaded | AgentPin credential verification |
| `client.schedules` | Lazy-loaded | Cron scheduling |
| `client.channels` | Lazy-loaded | Chat channel adapters |
| `client.workflows` | Lazy-loaded | Workflow execution |
| `client.metricsClient` | Lazy-loaded | Runtime metrics API |
| `client.system` | Lazy-loaded | Health and system info |
| `client.secrets` | Lazy-loaded | Secrets management |
| `client.mcp` | Lazy-loaded | MCP protocol |
| `client.toolReview` | Lazy-loaded | Tool review workflow |
| `client.http` | Lazy-loaded | HTTP endpoint management |

**Standalone modules** (not sub-clients — import directly):
- `MarkdownMemoryStore` — file-based context persistence
- `HmacVerifier` / `JwtVerifier` / `createProviderVerifier` — webhook verification
- `SkillScanner` / `SkillLoader` — skill scanning and loading
- `FileMetricsExporter` / `CompositeExporter` / `MetricsCollector` — local metrics export

---

## Configuration

```typescript
// Direct configuration
const client = new SymbiontClient({
    apiKey: 'your-api-key',
    environment: 'production',
    timeout: 30000,
    validationMode: 'strict',
});

// From environment variables
// SYMBIONT_API_KEY, SYMBIONT_ENVIRONMENT, SYMBIONT_BASE_URL
const client = new SymbiontClient();
```

---

## Pro Tips for AI Assistants

1. **Lazy-loaded sub-clients** — `client.agentpin`, `client.metricsClient`, `client.schedules`, etc. are initialized on first access
2. **AgentPin is ES256 only** — credentials use ECDSA P-256, no other algorithms accepted
3. **Short-lived credentials** — prefer TTLs of hours, not days
4. **Trust bundles** for offline/air-gapped environments — bundle discovery + revocation docs
5. **Memory hierarchy** — use short-term for conversation context, long-term for persistent knowledge
6. **Markdown memory** — use `MarkdownMemoryStore` for file-based agent context that survives restarts
7. **Webhook verification** — always use `createProviderVerifier()` for known providers; HMAC uses constant-time comparison
8. **Skill scanning** — always scan untrusted skills before loading; 10 built-in ClawHavoc rules catch common attacks
9. **Metrics export** — `FileMetricsExporter` uses atomic writes; `CompositeExporter` tolerates partial backend failures
10. **Policy-first design** — define policies before agent implementation
11. **Secrets via Vault** — never hardcode secrets, use the secrets management API

登录后下载/点赞/收藏 ❤ 2 | ★ 0

symbiont-sdk-js

目录结构

SKILL.md

举报内容

提示