Skip to content

DotCraft SDK

DotCraft SDKs are for external clients, social channel adapters, and automation integrations. They connect to the same AppServer Wire Protocol and reuse DotCraft's thread, streaming event, approval, and delivery capabilities.

Quick Start

  1. Read the AppServer Mode Guide first and decide between stdio and WebSocket.
  2. Choose Python SDK for standalone adapters.
  3. Choose TypeScript SDK for social channel modules.
  4. Start from the closest platform example, then replace tokens, callback URLs, and permission allowlists.

Configuration

GoalDocs
Build external channel adapters in PythonPython SDK
Reference the Telegram Python adapterPython Telegram Adapter
Build external channel modules in TypeScriptTypeScript SDK
Connect Feishu / LarkFeishu Adapter
Connect TelegramTelegram Adapter
Connect WeixinWeixin Adapter
Connect QQQQ Adapter
Connect WeComWeCom Adapter

Usage Examples

ScenarioRecommended entry
Build a Python botPython SDK + Telegram Adapter
Build a TypeScript social channelTypeScript SDK
Connect to an existing AppServerUse WebSocket transport
Let DotCraft host the adapter subprocessUse stdio / subprocess mode

Advanced Topics

Troubleshooting

Adapter cannot connect to DotCraft

Confirm AppServer is running in WebSocket mode, the URL includes /ws, and the token matches the client config.

Messages arrive but results cannot be delivered

Check whether the adapter declares delivery capabilities and channel tools during initialization. Platform tokens, callback URLs, and permission allowlists must also match.

You are not sure whether to choose Python or TypeScript

Choose Python for quick standalone adapters. Choose TypeScript when reusing existing channel modules, interactive setup, or platform packages.

Apache License 2.0