add-trpc-endpoint
Scaffold new tRPC API endpoints for the dealflow-network project with proper Zod validation, middleware, database functions, and client hooks. Use when adding new API routes, creating CRUD operations, or extending existing routers.
Best use case
add-trpc-endpoint is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Scaffold new tRPC API endpoints for the dealflow-network project with proper Zod validation, middleware, database functions, and client hooks. Use when adding new API routes, creating CRUD operations, or extending existing routers.
Teams using add-trpc-endpoint should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/add-trpc-endpoint/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How add-trpc-endpoint Compares
| Feature / Agent | add-trpc-endpoint | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Scaffold new tRPC API endpoints for the dealflow-network project with proper Zod validation, middleware, database functions, and client hooks. Use when adding new API routes, creating CRUD operations, or extending existing routers.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Add tRPC Endpoint
Scaffold complete tRPC endpoints following project patterns.
## Quick Start
When adding a new endpoint, I will:
1. Add Zod input schema to `server/routers.ts`
2. Create database function in `server/db.ts` (if needed)
3. Add procedure with appropriate middleware
4. Show client usage pattern
## Procedure Types
Choose based on auth requirements:
```typescript
// No authentication required
publicProcedure
// Requires logged-in user (ctx.user available)
protectedProcedure
// Requires admin role (ctx.user.role === 'admin')
adminProcedure
```
## Template: Query Endpoint
```typescript
// In server/routers.ts - add to appropriate router
const getItem = protectedProcedure
.input(z.object({
id: z.number(),
}))
.query(async ({ ctx, input }) => {
const db = await getDb();
if (!db) throw new TRPCError({ code: "INTERNAL_SERVER_ERROR" });
const [item] = await db
.select()
.from(items)
.where(eq(items.id, input.id));
if (!item) {
throw new TRPCError({ code: "NOT_FOUND", message: "Item not found" });
}
return item;
});
```
## Template: Mutation Endpoint
```typescript
const createItem = protectedProcedure
.input(z.object({
name: z.string().min(1, "Name is required"),
description: z.string().optional(),
categoryId: z.number().optional(),
}))
.mutation(async ({ ctx, input }) => {
const db = await getDb();
if (!db) throw new TRPCError({ code: "INTERNAL_SERVER_ERROR" });
const [result] = await db.insert(items).values({
...input,
createdBy: ctx.user.id,
createdAt: new Date(),
});
return { id: result.insertId, ...input };
});
```
## Template: List with Pagination
```typescript
const listItems = protectedProcedure
.input(z.object({
page: z.number().default(1),
limit: z.number().default(20),
search: z.string().optional(),
}))
.query(async ({ ctx, input }) => {
const db = await getDb();
if (!db) throw new TRPCError({ code: "INTERNAL_SERVER_ERROR" });
const offset = (input.page - 1) * input.limit;
let query = db.select().from(items);
if (input.search) {
query = query.where(like(items.name, `%${input.search}%`));
}
const results = await query.limit(input.limit).offset(offset);
return results;
});
```
## Adding to Router
```typescript
// In server/routers.ts
export const appRouter = router({
// ... existing routers
items: router({
list: listItems,
get: getItem,
create: createItem,
update: updateItem,
delete: deleteItem,
}),
});
```
## Client Usage
```typescript
// Query hook
const { data, isLoading, error } = trpc.items.list.useQuery({ page: 1 });
// Mutation hook
const createMutation = trpc.items.create.useMutation({
onSuccess: () => {
// Invalidate cache to refetch list
utils.items.list.invalidate();
toast.success("Item created");
},
onError: (error) => {
toast.error(`Failed: ${error.message}`);
},
});
// Call mutation
createMutation.mutate({ name: "New Item" });
```
## Common Zod Patterns
```typescript
// Required string with min length
name: z.string().min(1, "Required")
// Optional email
email: z.string().email().optional().or(z.literal(""))
// URL validation
linkedinUrl: z.string().url().optional().or(z.literal(""))
// Enum
status: z.enum(["pending", "active", "completed"])
// Array of IDs
tagIds: z.array(z.number())
// Nested object
metadata: z.object({
source: z.string(),
confidence: z.number(),
}).optional()
```
## Error Handling
```typescript
import { TRPCError } from "@trpc/server";
// Common error codes
throw new TRPCError({ code: "NOT_FOUND", message: "Item not found" });
throw new TRPCError({ code: "UNAUTHORIZED" });
throw new TRPCError({ code: "FORBIDDEN", message: "Admin only" });
throw new TRPCError({ code: "BAD_REQUEST", message: "Invalid input" });
throw new TRPCError({ code: "INTERNAL_SERVER_ERROR" });
```
## Checklist
- [ ] Input validation with Zod schema
- [ ] Appropriate procedure type (public/protected/admin)
- [ ] Database null check
- [ ] Error handling with TRPCError
- [ ] Add to router export
- [ ] Client cache invalidation strategyRelated Skills
add-api-endpoint
Create API layer components for a new entity. Includes usecase interactors (internal/usecase/), proto definitions (schema/proto/), gRPC handlers (internal/infrastructure/grpc/), and DI registration. Use when adding CRUD endpoints or Step 3 of CRUD workflow (after add-domain-entity).
add-api-endpoint-tassadar2499-novatune
Add a new minimal API endpoint to NovaTune with service, models, and tests
Add Admin API Endpoint
Add a new endpoint or endpoints to Ghost's Admin API at `ghost/api/admin/**`.
add-auth-endpoint
Add authentication endpoints (register, login, refresh, logout) to NovaTune
thor-skills
An entry point and router for AI agents to manage various THOR-related cybersecurity tasks, including running scans, analyzing logs, troubleshooting, and maintenance.
astro
This skill provides essential Astro framework patterns, focusing on server-side rendering (SSR), static site generation (SSG), middleware, and TypeScript best practices. It helps AI agents implement secure authentication, manage API routes, and debug rendering behaviors within Astro projects.
tech-blog
Generates comprehensive technical blog posts, offering detailed explanations of system internals, architecture, and implementation, either through source code analysis or document-driven research.
whisper-transcribe
Transcribes audio and video files to text using OpenAI's Whisper CLI, enhanced with contextual grounding from local markdown files for improved accuracy.
chrome-debug
This skill empowers AI agents to debug web applications and inspect browser behavior using the Chrome DevTools Protocol (CDP), offering both collaborative (headful) and automated (headless) modes.
ontopo
An AI agent skill to search for Israeli restaurants, check table availability, view menus, and retrieve booking links via the Ontopo platform, acting as an unofficial interface to its data.
ux
This AI agent skill provides comprehensive guidance for creating professional and insightful User Experience (UX) designs, covering user research, information architecture, interaction design, visual guidance, and usability evaluation. It aims to produce actionable, user-centered solutions that avoid generic AI aesthetics.
lets-go-rss
A lightweight, full-platform RSS subscription manager that aggregates content from YouTube, Vimeo, Behance, Twitter/X, and Chinese platforms like Bilibili, Weibo, and Douyin, featuring deduplication and AI smart classification.