agent id: lowercase letters, numbers, hyphens

Author: jahooma

common/src/__tests__/dynamic-agent-template-schema.test.ts

@@ -10,7 +10,7 @@ import {
 
 describe('DynamicAgentConfigSchema', () => {
   const validBaseTemplate = {
-    id: 'test_agent',
+    id: 'test-agent',
     version: '1.0.0',
     displayName: 'Test Agent',
     parentPrompt: 'A test agent',
@@ -143,7 +143,7 @@ describe('DynamicAgentConfigSchema', () => {
   describe('Invalid Templates', () => {
     it('should reject template with missing required fields', () => {
       const template = {
-        id: 'test_agent',
+        id: 'test-agent',
         // Missing other required fields
       }
 
@@ -201,6 +201,55 @@ describe('DynamicAgentConfigSchema', () => {
       expect(result.success).toBe(false)
     })
 
+    it('should reject template with invalid agent ID format', () => {
+      const invalidIds = [
+        'Test_Agent', // uppercase and underscore
+        'test agent', // space
+        'test.agent', // dot
+        'test@agent', // special character
+        'Test-Agent', // uppercase
+        '123_test', // underscore
+        'test/agent', // slash
+      ]
+
+      invalidIds.forEach((id) => {
+        const template = {
+          ...validBaseTemplate,
+          id,
+        }
+
+        const result = DynamicAgentConfigSchema.safeParse(template)
+        expect(result.success).toBe(false)
+        if (!result.success) {
+          expect(result.error.issues[0].message).toContain(
+            'lowercase letters, numbers, and hyphens'
+          )
+        }
+      })
+    })
+
+    it('should accept template with valid agent ID format', () => {
+      const validIds = [
+        'test-agent',
+        'test123',
+        'agent-v2',
+        'my-custom-agent-123',
+        'a',
+        '123',
+        'test-agent-with-many-hyphens',
+      ]
+
+      validIds.forEach((id) => {
+        const template = {
+          ...validBaseTemplate,
+          id,
+        }
+
+        const result = DynamicAgentConfigSchema.safeParse(template)
+        expect(result.success).toBe(true)
+      })
+    })
+
     it('should accept template with any parentInstructions agent ID at schema level', () => {
       const template = {
         ...validBaseTemplate,
@@ -359,4 +408,4 @@ describe('DynamicAgentConfigSchema', () => {
       )
     })
   })
-})
+})

common/src/types/dynamic-agent-template.ts

@@ -46,8 +46,8 @@ const JsonSchemaSchema: z.ZodType<any> = z.lazy(() =>
 const InputSchemaObjectSchema = z
   .object({
     prompt: z
-      .object({ 
-        type: z.literal('string'), 
+      .object({
+        type: z.literal('string'),
         description: z.string().optional(),
       })
       .passthrough()
@@ -82,7 +82,12 @@ const HandleStepsSchema = z
 
 // Validates the Typescript template file.
 export const DynamicAgentConfigSchema = z.object({
-  id: z.string(), // The unique identifier for this agent
+  id: z
+    .string()
+    .regex(
+      /^[a-z0-9-]+$/,
+      'Agent ID must contain only lowercase letters, numbers, and hyphens'
+    ), // The unique identifier for this agent
   version: z.string().optional(),
 
   // Required fields for new agents

common/src/util/agent-config.d.ts

@@ -21,7 +21,7 @@ type ToolName = Tools.ToolName
 // ============================================================================
 
 export interface AgentConfig {
-  /** Unique identifier for this agent. Use alphanumeric characters and hyphens only, e.g. 'code-reviewer' */
+  /** Unique identifier for this agent. Must contain only lowercase letters, numbers, and hyphens, e.g. 'code-reviewer' */
   id: string
 
   /** Version string (if not provided, will default to '0.0.1' and be bumped on each publish) */
@@ -259,7 +259,6 @@ export type FileEditingTools = FileTools | 'end_turn'
 export type ResearchTools = WebTools | 'write_file' | 'end_turn'
 export type CodeAnalysisToolSet = FileTools | CodeAnalysisTools | 'end_turn'
 
-
 // ============================================================================
 // Available Models (see: https://openrouter.ai/models)
 // ============================================================================