Withseismic MCP

🚀 Project D0 Documentation

D0 is a protocol dedicated to enabling efficient collaboration between humans and AI systems. By providing tools and prompt components, D0 allows developers to build modular AI solutions and supports multiple interaction modes, including text-based, file-based, or real-time data stream-based methods.

🚀 Quick Start

✨ Features

• Facilitates efficient collaboration between humans and AI systems.
• Enables developers to build modular AI solutions.
• Supports multiple interaction modes.

📦 Installation

Not provided in the original document, so this section is skipped.

💻 Usage Examples

Basic Usage

The following are examples of tools and prompts in D0:

Tool Example

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

Prompt Example

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

📚 Documentation

Core Concepts

Tools

Tools are executable functions that models can call. Each tool has the following characteristics:

• A clear input/output schema defined using Zod.
• Automatic registration in the registry.
• The ability to perform arbitrary operations, such as calculations, file I/O, or API calls.

Prompts

Prompts are components used to generate interaction messages. Each prompt has the following features:

• A clear parameter schema definition.
• The ability to generate messages in a consistent format.
• Automatic registration in the registry.

Architecture

Core Components

• Registry: The central manager of all tools and prompts.
• Tool: The base class for executable functions.
• Prompt: The base class for message generators.
• Server: The core implementation of the D0 protocol.

Automatic Registration

The system uses a singleton registry pattern:

1. Automatically registers tools and prompts upon import.
2. Provides type-safe component access.
3. Handles all protocol interactions.

Development

Type Safety

The entire system uses TypeScript to ensure type safety:

• Defines input/output schemas using Zod.
• Infers tool parameters and result types.
• Provides comprehensive error type definitions.

Testing

To run tests, use the following command:

pnpm test

Contribution Guidelines

Please refer to the Contribution Guidelines to learn about:

• The development process.
• Code style guidelines.
• The Pull Request handling process.
• The way to report issues.

Join our Discord community to collaborate with other contributors!

Support

Contact support:

• Email: hello@withseismic.com
• Discord: Join the server

🔧 Technical Details

The system uses TypeScript for type safety and Zod for schema definition. The singleton registry pattern is used to manage tools and prompts, ensuring efficient and organized component management.

📄 License

This project is licensed under the MIT License.
Copyright (c) 2024, WithSeismic