@cmssy/ai-tools

中文文档
0.111.0发布于 2026/11/10MITTypeScriptES Module近 30 天下载 1.1万

Transport-neutral AI tool-core shared by Cmssy Spotlight and cmssy-mcp

原始使用文档
文档目录3 节
  1. Install
  2. Usage
  3. Contract

@cmssy/ai-tools

Transport-neutral AI tool-core shared by Cmssy Spotlight (in-process admin assistant) and @cmssy/mcp-server (public MCP server).

Each tool is defined once - name, description, inputSchema, requiredPermissions, and an execute(input, ops) that runs against the abstract WorkspaceOps capability port. Each consumer supplies its own WorkspaceOps adapter (Spotlight: in-process repositories/services; MCP: the public GraphQL API via cs_* token) and a thin binder for its framework and return shape.

See the RFC docs/rfc/spotlight-mcp-shared-tools.md in the cmssy repo.

Install

npm install @cmssy/ai-tools zod

zod is a peer dependency.

Usage

import { AI_TOOLS, type WorkspaceOps } from "@cmssy/ai-tools";

const ops: WorkspaceOps = /* your adapter */;

for (const tool of AI_TOOLS) {
  // bind tool.name / tool.description / tool.inputSchema into your framework,
  // calling tool.execute(input, ops) and shaping the result for your transport.
}

Contract

  • Always shared: name, description, inputSchema, requiredPermissions, and the execute orchestration against WorkspaceOps.
  • Read/list outputs are transport-neutral domain summaries; each binder presents its own shape.
  • Write/action outputs are small identity DTOs that converge across surfaces.
  • requiredPermissions is enforced by Spotlight (admin session) and advisory for MCP (the public API is the gate).

版本与发布记录

@cmssy/ai-tools 共发布 122 个版本,首次发布于 2026/06/20;过去 12 个月发布了 122 个版本。

版本发布日期距今
0.111.0latest2026/11/10今天
0.110.02026/11/10今天
0.109.02026/11/091 天前
0.108.02026/11/063 天前
0.107.02026/11/063 天前
0.106.02026/11/063 天前

关于 @cmssy/ai-tools 的常见问题

@cmssy/ai-tools 是什么?

Transport-neutral AI tool-core shared by Cmssy Spotlight and cmssy-mcp

如何安装 @cmssy/ai-tools?

在项目目录运行 npm install @cmssy/ai-tools,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zod(^4)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@cmssy/ai-tools 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@cmssy/ai-tools 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@cmssy/ai-tools 可以商用吗?

@cmssy/ai-tools 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@cmssy/ai-tools 的下载量有多少?

根据 npm 官方下载统计,@cmssy/ai-tools 在 2026/10/10 – 2026/11/08 这 30 天内被下载 10,898 次,日均约 363 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cmssy/ai-tools 还在维护吗?

最新版本 0.111.0 发布于 2026/11/10(今天);至今共发布 122 个版本,其中过去 12 个月发布了 122 个;首次发布于 2026/06/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。