Avala TypeScript SDK+MCP服务器
](https://www.npmjs.com/package/@avala-ai/sdk) ](https://www.npmjs.com/package/@avala-ai/mcp-server)  
官方TypeScript SDK和MCP服务器 阿瓦拉API.以编程方式构建和管理ML注释数据集、项目、导出和任务。
包裹
| 包 | 版本 | 描述 |
|---|---|---|
@avala-ai/sdk | 0.5.0 | 适用于Avala API的TypeScript SDK |
@avala-ai/mcp-server | 0.5.0 | 用于AI助手集成的MCP服务器 |
SDK快速入门
npm install @avala-ai/sdkimport Avala from "@avala-ai/sdk";
const avala = new Avala(); // reads AVALA_API_KEY env var
// List datasets
const page = await avala.datasets.list({ limit: 10 });
page.items.forEach(d => console.log(d.uid, d.name));
// Get a specific dataset
const dataset = await avala.datasets.get("dataset-uid");
// Create an export
const exp = await avala.exports.create({ project: "project-uid" });
console.log(exp.uid, exp.status);
// List tasks with filters
const tasks = await avala.tasks.list({ project: "project-uid", status: "completed" });认证
客户端从 AVALA_API_KEY 默认环境变量:
export AVALA_API_KEY="avk_your_api_key"或者明确地传递它:
const avala = new Avala({ apiKey: "avk_your_api_key" });分页
全部 .list() 方法返回a CursorPage 随着 .items, .hasMore,以及 .nextCursor:
let page = await avala.datasets.list({ limit: 20 });
for (const dataset of page.items) {
console.log(dataset.name);
}
if (page.hasMore) {
const nextPage = await avala.datasets.list({ cursor: page.nextCursor });
}错误处理
import Avala, { AvalaError, NotFoundError, RateLimitError } from "@avala-ai/sdk";
try {
const dataset = await avala.datasets.get("nonexistent");
} catch (e) {
if (e instanceof NotFoundError) {
console.log("Dataset not found");
} else if (e instanceof RateLimitError) {
console.log("Rate limited");
} else if (e instanceof AvalaError) {
console.log(`API error: ${e.message}`);
}
}可用资源
| 资源 | 方法 | 描述 |
|---|---|---|
avala.datasets | list(), get(uid) | 浏览和检查数据集 |
avala.projects | list(), get(uid) | 浏览和检查项目 |
avala.exports | list(), get(uid), create() | 创建和管理注释导出 |
avala.tasks | list(), get(uid) | 使用项目/状态筛选器浏览任务 |
avala.storageConfigs | list(), create(), test(), delete() | 管理云存储连接 |
MCP 服务器
这 @avala-ai/mcp-server 该软件包提供了一个MCP服务器,允许AI助手(Claude等)与您的Avala数据进行交互。
npm install -g @avala-ai/mcp-server
avala-mcp-server看 MCP设置指南 有关配置详细信息。
发展
这是一个pnpm monorepo。开始:
pnpm install
pnpm -r build
pnpm -r test文档
许可证
麻省理工学院-见 许可证 了解详情。
