Three-role capability design
Concept reference
Section titled “Concept reference”When a capability is general enough to need replaceable providers, such as Bash execution, Harness separates three roles: a Service Definition, a Service Provider, and a Consumer. Put the roles in separate packages when they need to evolve or be replaced independently; a package may otherwise own more than one role. The complete capability is its seam. No individual role is a seam.
Bash example
Section titled “Bash example”The Bash execution capability consists of:
- Service Definition (
dsh-shell) — defines the Cordis service and Bash request and result types - Service Provider (
dsh-bash-local) — executes commands on the local machine - Consumer (
dsh-tool-bash) — exposes the capability as a model-callable tool
┌─────────────┐ ┌──────────────────┐ ┌──────────────┐│ dsh-shell │────▶│ dsh-bash-local │ │ dsh-tool-bash││(definition) │ │ (provider) │ │(consumer/tool)│└─────────────┘ └──────────────────┘ └──────────────┘ ▲ │ └────────────────────────────────────────────┘ inject: ['shell']Benefits of the split
Section titled “Benefits of the split”Replace providers
Section titled “Replace providers”One Service Definition can have multiple providers selected through cordis.yml:
# Local execution- name: '@deepseek-ai/dsh-bash-local'
# Replace this row with another package that provides the same service.The Service Definition and tool remain unchanged while the provider changes.
Evolve independently
Section titled “Evolve independently”- The Service Definition changes rarely after callers depend on its contract.
- Service Providers can improve performance and security independently.
- Consumers can change how they present the capability to the model.
Decouple dependencies
Section titled “Decouple dependencies”- The Service Provider depends on the Service Definition.
- The Consumer depends on the Service Definition.
- The Service Provider and Consumer do not depend on each other.
The capability-seam reference owns the current built-in families and package links.
Tutorial: develop a three-role capability
Section titled “Tutorial: develop a three-role capability”Step 1: write the Service Definition
Section titled “Step 1: write the Service Definition”import { Service, type Context } from '@deepseek-ai/cordis'
declare module '@deepseek-ai/cordis' { interface Context { myCap: MyCapService }}
export abstract class MyCapService extends Service { constructor(ctx: Context) { super(ctx, 'myCap') }
/** Execute the capability. */ abstract execute(request: MyCapRequest): Promise<MyCapResult>}
export interface MyCapRequest { input: string}
export interface MyCapResult { output: string}Step 2: write a Service Provider
Section titled “Step 2: write a Service Provider”import type { Context } from '@deepseek-ai/cordis'import { MyCapService, type MyCapRequest, type MyCapResult } from '@deepseek-ai/dsh-my-cap'
class MyCapLocal extends MyCapService { async execute(request: MyCapRequest): Promise<MyCapResult> { // Local provider behavior. return { output: request.input.toUpperCase() } }}
export const name = 'my-cap-local'
export function apply(ctx: Context) { ctx.plugin(MyCapLocal)}Step 3: write a consumer
Section titled “Step 3: write a consumer”import type { Context } from '@deepseek-ai/cordis'import { defineTool } from '@deepseek-ai/dsh-tools'
export const name = 'tool-my-cap'export const inject = ['tools', 'myCap']
export function apply(ctx: Context) { ctx.tools.register(defineTool({ name: 'my_cap', description: 'Execute my capability.', parameters: { input: { type: 'string', required: true }, }, output: { schema: { type: 'string' }, render: (_args, value) => [{ type: 'text', text: value }], }, async execute(args) { const result = await ctx.myCap.execute({ input: args.input }) return result.output }, }))}Compose them in cordis.yml
Section titled “Compose them in cordis.yml”- name: '@deepseek-ai/dsh-my-cap-local'- name: '@deepseek-ai/dsh-tool-my-cap'Design points
Section titled “Design points”- Do not split preemptively — use separate packages only when the roles need to evolve independently. A simple tool plugin does not.
- The Service Definition owns Request/Result types — Service Providers and Consumers depend only on the Service Definition package.
- Explicit > implicit — resolve defaults in an explicit
resolve(request): Specstep rather than hiding?? defaultexpressions insiderun().
Next steps
Section titled “Next steps”- LLM adapter — implement an LLM provider