TRPC Router Guide

SkillDev tools

Guides your agent to write tRPC server routers, procedures and API endpoints following this codebase's conventions.

Use TRPC Router Guide in Claude, ChatGPT or Ahel Desktop

Free. Sign in, add TRPC Router Guide and connect your AI. About a minute.

Also: Claude Code · Cursor · Codex

Then ask your AI: use the TRPC Router Guide skill

Details

Instructions available. Your AI can read the instructions. Execution depends on the setup they require.

Add ahel to your AI once: Claude, ChatGPT, Cursor, Claude Code or Codex. Then ask it to use this.

TRPC Router GuideStart free
About this skill

Use for server TRPC routers, procedures and API endpoints in apps/server/src/routers.

What this skill tells your AI

The instructions your AI receives, as published by lobehub/lobehub in .agents/skills/trpc-router/SKILL.md and read by ahel’s review.

File Location

  • Routers: apps/server/src/routers/lambda/<domain>.ts
  • Helpers: apps/server/src/routers/lambda/_helpers/
  • Schemas: apps/server/src/routers/lambda/_schema/

Router Structure

Imports

import { TRPCError } from '@trpc/server';
import { z } from 'zod';

import { SomeModel } from '@/database/models/some';
import { authedProcedure, router } from '@/libs/trpc/lambda';
import { serverDatabase } from '@/libs/trpc/lambda/middleware';

Middleware: Inject Models into ctx

Always use middleware to inject models into ctx instead of creating new Model(ctx.serverDB, ctx.userId) inside every procedure.

const domainProcedure = authedProcedure.use(serverDatabase).use(async (opts) => {
  const { ctx } = opts;
  return opts.next({
    ctx: {
      fooModel: new FooModel(ctx.serverDB, ctx.userId),
      barModel: new BarModel(ctx.serverDB, ctx.userId),
    },
  });
});

Then use ctx.fooModel in procedures:

// Good
const model = ctx.fooModel;

// Bad - don't create models inside procedures
const model = new FooModel(ctx.serverDB, ctx.userId);

Exception: When a model needs a different userId (e.g., watchdog iterating over multiple users' tasks), create it inline.

Procedure Pattern

export const fooRouter = router({
  // Query
  find: domainProcedure.input(z.object({ id: z.string() })).query(async ({ input, ctx }) => {
    try {
      const item = await ctx.fooModel.findById(input.id);
      if (!item) throw new TRPCError({ code: 'NOT_FOUND', message: 'Not found' });
      return { data: item, success: true };
    } catch (error) {
      if (error instanceof TRPCError) throw error;
      console.error('[foo:find]', error);
      throw new TRPCError({
        cause: error,
        code: 'INTERNAL_SERVER_ERROR',
        message: 'Failed to find item',
      });
    }
  }),

  // Mutation
  create: domainProcedure.input(createSchema).mutation(async ({ input, ctx }) => {
    try {
      const item = await ctx.fooModel.create(input);
      return { data: item, message: 'Created', success: true };
    } catch (error) {
      if (error instanceof TRPCError) throw error;
      console.error('[foo:create]', error);
      throw new TRPCError({
        cause: error,
        code: 'INTERNAL_SERVER_ERROR',
        message: 'Failed to create',
      });
    }
  }),
});

Aggregated Detail Endpoint

For views that need multiple related data, create a single detail procedure that fetches everything in parallel:

detail: domainProcedure.input(idInput).query(async ({ input, ctx }) => {
  const item = await resolveOrThrow(ctx.fooModel, input.id);

  const [children, related] = await Promise.all([
    ctx.fooModel.findChildren(item.id),
    ctx.barModel.findByFooId(item.id),
  ]);

  return {
    data: { ...item, children, related },
    success: true,
  };
}),

This avoids the CLI or frontend making N sequential requests.

Conventions

  • Return shape: { data, success: true } for queries, { data?, message, success: true } for mutations
  • Error handling: re-throw TRPCError, wrap others with console.error + new TRPCError
  • Input validation: use zod schemas, define at file top
  • Router name: export const fooRouter = router({ ... })
  • Procedure names: alphabetical order within the router object
  • Log prefix: [domain:procedure] format, e.g. [task:create]

Others that do the same job

Advanced
Item type
skill
Key
trpc-router-lobehub
Source
github.com/lobehub/lobehub