D0 项目文档

概述

D0 是一个专注于实现人与 AI 系统之间高效协作的协议。通过提供工具和提示组件，D0 允许开发者构建模块化的人工智能解决方案，并支持多种交互模式，包括基于文本、文件或实时数据流的方式。

核心概念

工具（Tools）

工具是模型可以调用的执行函数。每个工具都具有：

• 明确的输入/输出 schema 使用 Zod 定义
• 自动注册到资源库中
• 可以执行任意操作，如计算、文件 I/O 或 API 调用

示例工具：

import { z } from "zod";
import { Tool } from "../core";

const MyToolInputSchema = z.object({
  param1: z.string().describe("Parameter description"),
});

const MyToolOutputSchema = z.object({
  result: z.string().describe("Result description"),
});

export const myTool = new Tool(
  {
    name: "myTool",
    description: "What my tool does",
    inputSchema: MyToolInputSchema,
    outputSchema: MyToolOutputSchema,
  },
  async (args) => {
    const input = MyToolInputSchema.parse(args);
    // 工具逻辑
    return { result: "processed result" };
  },
);

提示（Prompts）

提示是用于生成交互消息的组件。每个提示都具有：

• 明确的参数 schema 定义
• 以一致格式生成消息
• 自动注册到资源库中

示例提示：

import { Prompt } from "../core";

export const myPrompt = new Prompt(
  {
    name: "myPrompt",
    description: "What my prompt does",
    arguments: [
      {
        name: "arg1",
        description: "Argument description",
        required: true,
      },
    ],
  },
  async (args) => {
    return [
      {
        role: "system",
        content: {
          type: "text",
          text: `Generated message using ${args.arg1}`,
        },
      },
    ];
  },
);

架构

核心组件

• 资源库（Registry）：所有工具和提示的中央管理者
• 工具（Tool）：可执行函数的基础类
• 提示（Prompt）：消息生成器的基础类
• 服务器（Server）：实现 D0 协议的核心

自动注册

系统采用单例资源库模式：

1. 在导入时自动注册工具和提示
2. 提供类型安全的组件访问
3. 处理所有协议交互

开发

类型安全

整个系统使用 TypeScript 保障类型安全：

• 使用 Zod 定义输入/输出 schema
• 推断工具参数和结果类型
• 提供全面的错误类型定义

测试

运行测试：

pnpm test

贡献指南

请参考 贡献指南 了解：

• 开发流程
• 代码风格规范
• Pull Request 处理流程
• 问题报告方式

加入我们的 Discord 社区，与其他贡献者协作！

支持

联系支持：

• 邮件：hello@withseismic.com
• Discord：加入服务器

许可证

本项目遵守 MIT 协议。
版权所有 (c) 2024, WithSeismic