Withseismic MCP

🚀 D0 项目文档

D0 协议致力于实现人与 AI 系统的高效协作。它为开发者提供工具和提示组件，助力构建模块化人工智能解决方案，支持基于文本、文件或实时数据流等多种交互模式。

🚀 快速开始

在后续章节中，你将了解到 D0 协议的核心概念、架构、开发要点等内容，从而快速上手使用 D0 进行开发。

✨ 主要特性

• 支持人与 AI 系统的高效协作。
• 提供工具和提示组件，便于开发者构建模块化的人工智能解决方案。
• 支持多种交互模式，包括基于文本、文件或实时数据流的方式。
• 采用单例资源库模式，实现工具和提示的自动注册。
• 使用 TypeScript 保障类型安全。

📦 安装指南

文档中未提及具体安装步骤，暂无法提供。

💻 使用示例

基础用法

工具示例

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" };
  },
);

提示示例

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}`,
        },
      },
    ];
  },
);

📚 详细文档

核心概念

工具（Tools）

工具是模型可以调用的执行函数。它具有以下特点：

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

提示（Prompts）

提示是用于生成交互消息的组件。其特点如下：

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

架构

核心组件

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

自动注册

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

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

开发

类型安全

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

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

🔧 技术细节

D0 协议通过资源库对工具和提示进行集中管理，利用 TypeScript 和 Zod 保障类型安全和输入输出的规范性。工具和提示在导入时会自动注册到资源库，便于统一管理和调用。通过明确的 schema 定义，使得系统的各个组件具有良好的可维护性和扩展性。在开发过程中，开发者可以基于已有的工具和提示基础类进行扩展，实现自定义的功能。

📄 许可证

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

💡 使用建议

• 在开发新的工具和提示时，严格按照文档中定义的 schema 进行编写，以确保类型安全和系统的稳定性。
• 可以参考示例代码，快速上手工具和提示的开发。

⚠️ 重要提示

• 确保在运行测试前，项目的依赖已经正确安装，避免出现运行时错误。
• 在修改工具和提示的代码时，要注意对已有功能的影响，避免引入新的问题。