OpenWriterControle/plugins/claude-code/scripts/context/openagents-repo/examples/baseadapter-implementation.md
Darren Hinde a8fc9c7715
feat(plugin): enhance context management and skill invocation (#239)
* fix(shellcheck): declare and assign separately in router.sh (SC2155)

* feat(plugin): enhance context management and skill invocation

- Update .context-manifest.json to include profile and detailed source information.
- Revise context-scout.md to clarify context root discovery and navigation.
- Modify commands to replace deprecated skills with updated ones (brainstorming → approach, systematic-debugging → debugger).
- Streamline install-context.md for clarity and remove interactive profile selection.
- Improve oac-status.md to provide a more comprehensive status report.
- Add OAC system paths to session-start.sh for better context management.
- Remove obsolete skills and improve documentation for existing commands.
2026-02-23 12:12:29 +00:00

160 lines
3.9 KiB
Markdown

<!-- Context: openagents-repo/examples | Priority: high | Version: 1.0 | Updated: 2026-02-15 -->
# Example: BaseAdapter Implementation Pattern
**Purpose**: Template method pattern for AI tool adapters
**Last Updated**: 2026-02-04
---
## Core Pattern
**Template Method**: BaseAdapter defines algorithm structure, subclasses implement tool-specific details
---
## BaseAdapter Structure
```typescript
export abstract class BaseAdapter {
abstract name: string
abstract displayName: string
// Must implement
abstract toOAC(source: string): Promise<OpenAgent>
abstract fromOAC(agent: OpenAgent): Promise<ConversionResult>
abstract getConfigPath(): string
abstract getCapabilities(): ToolCapabilities
abstract validateConversion(agent: OpenAgent): string[]
// Shared utilities
supportsFeature(feature: keyof ToolCapabilities): boolean
warn(message: string): void
createSuccessResult(configs, warnings): ConversionResult
safeParseJSON(content, filename): unknown | null
unsupportedFeatureWarning(feature, value): string
degradedFeatureWarning(feature, from, to): string
}
```
---
## Implementation Example
```typescript
export class WindsurfAdapter extends BaseAdapter {
name = 'windsurf'
displayName = 'Windsurf'
async toOAC(source: string): Promise<OpenAgent> {
const config = this.safeParseJSON(source, 'config.json')
return {
frontmatter: {
name: config.name,
model: this.mapWindsurfModelToOAC(config.model),
tools: this.parseWindsurfTools(config.tools),
temperature: this.mapCreativityToTemperature(config.creativity)
},
systemPrompt: config.systemPrompt,
contexts: []
}
}
async fromOAC(agent: OpenAgent): Promise<ConversionResult> {
const warnings: string[] = []
// Warn on unsupported features
if (agent.frontmatter.hooks) {
warnings.push(this.unsupportedFeatureWarning('hooks', 'lost'))
}
const config = {
name: agent.frontmatter.name,
model: this.mapOACModelToWindsurf(agent.frontmatter.model),
creativity: this.mapTemperatureToCreativity(agent.frontmatter.temperature)
}
return this.createSuccessResult([
{ fileName: '.windsurf/config.json', content: JSON.stringify(config) }
], warnings)
}
getCapabilities(): ToolCapabilities {
return {
supportsMultipleAgents: true,
supportsHooks: false,
supportsTemperature: true // via creativity
}
}
}
```
---
## Key Methods
### toOAC()
Parse tool format → OpenAgent object
- Parse source (JSON/YAML)
- Map fields
- Validate with Zod
- Return OpenAgent
### fromOAC()
Convert OpenAgent → tool format
- Validate input
- Map fields
- Detect unsupported features → warnings
- Generate config files
### getCapabilities()
Declare supported features (used for validation)
---
## Utility Usage
```typescript
// Safe parsing
const config = this.safeParseJSON(content, 'config.json')
// Feature checks
if (this.supportsFeature('supportsTemperature')) {
config.temperature = agent.frontmatter.temperature
}
// Warnings
if (!this.supportsFeature('supportsHooks')) {
warnings.push(this.unsupportedFeatureWarning('hooks'))
}
// Results
return this.createSuccessResult([{ fileName, content }], warnings)
```
---
## Design Principles
1. **Template Method** - Base defines structure, subs fill details
2. **Pure toOAC/fromOAC** - Deterministic conversion
3. **Capabilities First** - Declare support upfront
4. **Graceful Degradation** - Warn, don't fail
5. **Validate Early** - Check before converting
---
## Reference
**Implementation**: `packages/compatibility-layer/src/adapters/BaseAdapter.ts`
**Concrete Adapters**:
- ClaudeAdapter.ts (600 lines)
- CursorAdapter.ts (554 lines)
- WindsurfAdapter.ts (514 lines)
**Related**:
- concepts/compatibility-layer.md
- guides/compatibility-layer-development.md
- lookup/compatibility-layer-adapters.md