跳到主要内容

代理开发者指南

欢迎来到 Agentrix 代理开发文档。本指南将帮助您为 Agentrix 平台构建自定义代理。

什么是 Agentrix 代理？​

Agentrix 代理是一个配置为执行特定任务的专用 AI 助手。每个代理都是：

  • 自包含 : 一个具有标准结构的 git 仓库
  • 框架无关 : 支持 Claude Agent SDK 和 OpenAI Codex
  • 可定制 : 钩子、MCP 服务器、技能和自定义提示
  • 类型安全 : 钩子和配置支持完整的 TypeScript

快速入门​

有关详细说明，请参阅入门指南 。

文档结构​

核心概念​

  1. 入门指南

    • 创建你的第一个代理
    • 代理目录结构
    • 基本配置

  2. 代理结构

    • agent.json 元数据
    • 框架特定目录 (claude/, .codex/)
    • 文件组织

  3. 配置

    • config.json 架构
    • 系统提示
    • 权限模式
    • 工具白名单

钩子系统​

钩子系统允许你在关键生命周期节点拦截和定制代理行为。

  1. 钩子系统概述

    • 钩子是什么？
    • 何时使用钩子
    • 钩子执行流程

  2. 开发指南

    • TypeScript 设置
    • 类型安全与 @agentrix/shared
    • 测试钩子

  3. 钩子类型参考

    • Claude SDK 钩子类型
    • 输入/输出模式
    • 执行顺序

  4. 特定钩子文档 :

高级功能​

  1. MCP 服务器

    • 集成模型上下文协议服务器
    • 配置和管理

  2. 技能

    • 创建可重用技能
    • 技能市场（未来）

质量保证​

  1. 测试
  • 本地测试
  • 集成测试
  • CI/CD 流水线
  1. 最佳实践
  • 代理设计模式
  • 错误处理
  • 安全考虑
  • 性能优化

参考​

  1. API 参考
  • TypeScript 类型
  • 模式定义
  • 钩子签名

示例​

简单代理​

// agent.json
{
  "name": "code-reviewer",
  "version": "1.0.0",
  "description": "Automated code review assistant"
}
// claude/hooks/src/index.ts
import type { PreToolUseHookInput } from '@anthropic-ai/claude-agent-sdk';

export async function PreToolUse(
  input: PreToolUseHookInput,
  toolUseID: string,
  options: { signal: AbortSignal }
) {
  // Approve all Edit tool calls
  if (input.tool_name === 'Edit') {
    return { decision: 'approve' };
  }

  // Ask for confirmation for other tools
  return {};
}

查看完整示例以获取更多模式。

获取帮助​

相关文档​