Manage Database Usage

Mechanism 1: Middleware (/manage routes)

The branchScopedDbMiddleware (in agents-api/src/middleware/branchScopedDb.ts) runs on all /manage routes. It:

1. Acquires a dedicated connection from the pool
2. Checks out the correct branch (from the request's resolved ref)
3. Creates a Drizzle client scoped to that connection
4. Injects it into context as 'db'
5. Executes the route handler
6. Auto-commits on success for write operations
7. Cleans up: checks out main and releases connection

Usage

async (c) => {
  const db: AgentsManageDatabaseClient = c.get('db');
  const { tenantId, projectId } = c.req.valid('param');

  const tools = await listTools(db)({
    scopes: { tenantId, projectId },
  });

  return c.json({ data: tools });
}

Rules

• ALWAYS use c.get('db') inside manage routes — never import and use the global manageDbClient directly (it isn't checked out to any branch)
• Don't manually commit — the middleware auto-commits successful writes and resets on failure
• The resolvedRef is also available via c.get('resolvedRef') if needed

Mechanism 2: withRef (outside manage routes)

Use withRef from @inkeep/agents-core (defined in packages/agents-core/src/dolt/ref-scope.ts) when accessing manage data from /run, /evals, services, or other packages.

Read

import { withRef } from '@inkeep/agents-core';
import manageDbPool from '../data/db/manageDbPool';

const agent = await withRef(manageDbPool, resolvedRef, (db) =>
  getFullAgent(db)({
    scopes: { tenantId, projectId, agentId },
  })
);

Write with auto-commit

await withRef(
  manageDbPool,
  resolvedRef,
  async (db) => {
    await updateAgent(db, agentId, data);
  },
  { commit: true, commitMessage: 'Update agent config' }
);

Batching operations

Batch multiple operations in a single withRef to use one connection and one checkout:

const result = await withRef(
  manageDbPool,
  resolvedRef,
  async (db) => {
    await createCredential(db, credData);
    await updateTool(db, toolId, { credentialId });
    return { success: true };
  },
  {
    commit: true,
    commitMessage: 'Link credential to tool',
    author: { name: 'oauth-flow', email: '[email protected]' },
  }
);

Rules

• withRef acquires, scopes, and releases the connection — don't manage connections yourself
• For reads, omit the options (no commit needed)
• For writes, pass { commit: true } with an appropriate commitMessage
• On failure, if commit: true, uncommitted changes are automatically reset

Obtaining a resolvedRef

Most code paths already have a resolvedRef available:

• Hono routes: c.get('resolvedRef') (set by ref middleware)
• Agent runtime: this.executionContext.resolvedRef
• Service params: passed as a function parameter

If you need to resolve a branch ref manually:

import { getProjectScopedRef, resolveRef } from '@inkeep/agents-core';

const projectScopedRef = getProjectScopedRef(tenantId, projectId, 'main');
const resolvedRef = await resolveRef(agentsManageDbClient)(projectScopedRef);

The ResolvedRef type has three fields:

type ResolvedRef = {
  type: 'branch' | 'tag' | 'commit';
  name: string;  // e.g. "acme_proj_123_main"
  hash: string;  // commit hash
};

Key Files