Skip to Content
ReferenceSDK ReferenceOverview

SDK Overview

API reference for the Myco SDK.

Installation

npm install @myco-dev/sdk

Package exports

The SDK is organized into entry points:

Import pathDescription
@myco-dev/sdkCore: MycoSDK, MycoProvider, useMyco
@myco-dev/sdk/authAuth: useAuth, ProtectedRoute
@myco-dev/sdk/dataData types: Entity, RecordEntry, etc.
@myco-dev/sdk/workspaceWorkspace types
@myco-dev/sdk/chatChat: ChatPage, getToolIcon
@myco-dev/sdk/serverServer: createServerSDK
@myco-dev/sdk/markdownMarkdown: Markdown component

Quick start

import { MycoSDK, MycoProvider, useMyco } from "@myco-dev/sdk"; import type { EntityTypes } from "./types/myco.generated"; // 1. Create SDK instance const myco = new MycoSDK<EntityTypes>("your-app-key"); // 2. Wrap your app function App() { return ( <MycoProvider myco={myco}> <YourRoutes /> </MycoProvider> ); } // 3. Use in components function MyComponent() { const myco = useMyco<EntityTypes>(); const { data } = myco.data.useRecords("task"); // ... }

Peer dependencies

PackageVersion
react^18 || ^19
@tanstack/react-query^5.0.0
better-auth^1.4
ai^4.0 || ^5.0 || ^6.0

Optional peer dependencies (for chat and markdown features):

PackageVersionUsed by
@ai-sdk/react^1.0 || ^2.0 || ^3.0Chat
@markdoc/markdoc^0.4Markdown
framer-motion^11.0 || ^12.0Chat animations
lucide-react^0.400Chat icons
clsx^2.0Chat styling