@scribed/cli 0.0.0-stage → 0.1.1

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@scribed/cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Command-line client + MCP server for Scribed — CRM records, phone + texting, inbox, calendar + booking, transcriptions, HR, Vault, automations, Creative Studio, and Documents, derived from the scribed-agent tool catalog.",
+  "type": "module",
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://scribed.ai",
+  "keywords": [
+    "scribed",
+    "mcp",
+    "cli",
+    "crm",
+    "agent"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "bin": {
+    "scribed": "bin/scribed.mjs"
+  },
+  "exports": {
+    "./mcp": {
+      "types": "./types/mcp.d.ts",
+      "bun": "./dist/mcp/server.js",
+      "default": "./dist/mcp/server.js"
+    }
+  },
+  "files": [
+    "bin",
+    "dist",
+    "types"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/q6th/scribed-web.git",
+    "directory": "scribed-cli"
+  },
+  "gitHead": "d4ccf0b5a26adb950280324ff4624e34d7cffb43",
+  "scribedRelease": {
+    "repository": "q6th/scribed-web",
+    "commit": "d4ccf0b5a26adb950280324ff4624e34d7cffb43"
+  }
+}

package/types/mcp.d.ts

@@ -0,0 +1,163 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import type { z } from 'zod';
+
+/**
+ * Public surface of `@scribed/cli/mcp` — the catalog adapter + MCP server
+ * factory the hosted scribed-api `/mcp` and `/v1/tools` routes build on.
+ * Hand-maintained to match `src/mcp/server.ts`.
+ */
+
+export interface PublicToolCatalogItem {
+  name: string;
+  category: string;
+  description: string;
+  access: 'Standard' | 'AI-powered' | 'Storage/processing' | 'Connected account';
+}
+
+export interface CatalogToolDefinition {
+  description: string;
+  inputSchema: z.ZodType;
+  execute: (
+    args: unknown,
+    options: { toolCallId: string; messages: never[] }
+  ) => unknown;
+  httpMethod?: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
+  readOnly?: boolean;
+  binaryUpload?: BinaryUploadDescriptor;
+  /** Complete image results are rendered as native MCP image content. */
+  outputKind?: 'image';
+}
+
+export interface BinaryUploadDescriptor {
+  argumentName: string;
+  maxBytes: number;
+  inlineMaxBytes?: number;
+  allowEmpty?: boolean;
+  directUpload?: { provider: 'vercel-blob'; startTool: string; completeTool: string; cancelTool: string };
+}
+export interface ToolUpload { stream: ReadableStream<Uint8Array>; size: number; name: string; mimeType: string; maxBytes: number; contentSha256?: string }
+
+export interface ToolExecutionReceipt {
+  state: 'running' | 'completed' | 'failed' | 'unknown' | 'retryable';
+  requestId: string;
+  startedAt: string;
+  completedAt: string | null;
+  duplicateSuppressed: boolean;
+  resultAvailable: false;
+}
+
+export interface CatalogToolError {
+  error: true;
+  message: string;
+  code?: string;
+  status?: number | null;
+  retryAfterSeconds?: number;
+  receipt?: ToolExecutionReceipt;
+  requestId?: string;
+  idempotencyKey?: string;
+}
+
+export interface CatalogToolInvocation {
+  id: string;
+  name: string;
+  feature: string;
+  classification: 'paid' | 'usage_only' | 'overhead' | 'byok';
+  owner: 'agent' | 'app-worker' | 'downstream-worker' | 'user-provider';
+  providerCost: 'platform' | 'zero_byok' | 'none';
+  platformInfrastructure: true;
+  outcome: 'completed' | 'failed' | 'cancelled';
+  durationMs: number;
+  status?: number;
+}
+
+export interface CatalogCallContext {
+  apiUrl: string;
+  /** Better Auth bearer session token or hosted-MCP OAuth access token. */
+  token?: string;
+  /** Personal API key (`scribed_api_…`): executes through POST /v1/tools/:name. */
+  apiKey?: string;
+  /** Selected workspace: X-Workspace-Id (bearer / API key) or ?workspace= (hosted MCP). */
+  workspaceId?: string;
+  /** Browser-OAuth CLI sessions execute through the hosted MCP resource. */
+  remoteMcpUrl?: string;
+  /** Hosted Scribed API only; never accepted from CLI flags or environment. */
+  mcpSigningKey?: string;
+  uploads?: ReadonlyMap<string, ToolUpload>;
+  signal?: AbortSignal;
+  uploadApiUrl?: string;
+  idempotencyKey?: string;
+  billing?: {
+    consumerApp: 'scribed';
+    userId: string;
+    tenantId: string;
+    traceId: string;
+    feature: string;
+  };
+}
+
+export interface CatalogExecutionResult {
+  result: unknown;
+  toolInvocations: CatalogToolInvocation[];
+}
+
+export interface McpServerOptions {
+  apiUrl: string;
+  token?: string;
+  /** "core" (default), "all", or comma-separated category slugs. */
+  categories?: string;
+  /** Hosted Scribed API only; signs catalog-derived loopback requests. */
+  internalSigningKey?: string;
+  /** Hosted Scribed API only; omit state-changing tools. */
+  readOnly?: boolean;
+  /** Local API-key discovery: exact tool names allowed by the deployment. */
+  allowedTools?: readonly string[];
+  /** Pin every tool call to one workspace. */
+  workspaceId?: string;
+  /** Local stdio only; resolves/refreshes its execution credentials per call. */
+  contextProvider?: () => Promise<CatalogCallContext>;
+  /** Hosted API only: wraps validated calls in its durable execution receipt. */
+  executeTool?: (name: string, args: unknown, context: CatalogCallContext, extra: McpToolCallExtra) => Promise<unknown>;
+}
+
+export interface McpToolCallExtra {
+  signal: AbortSignal;
+  _meta?: Record<string, unknown>;
+  requestId?: string | number;
+}
+
+export declare const SERVER_INSTRUCTIONS: string;
+
+export declare function createMcpServer(options: McpServerOptions): McpServer;
+
+export declare function resolveCategorySelection(
+  selection?: string
+): ReadonlySet<string>;
+
+export declare function catalogItems(): PublicToolCatalogItem[];
+export declare function catalogRegistry(): Record<string, CatalogToolDefinition>;
+export declare function catalogCategories(): string[];
+export declare function catalogCounts(): {
+  total: number;
+  eligible: number;
+  excluded: number;
+};
+export declare function toolArgsJsonSchema(name: string): Record<string, unknown>;
+export declare function mcpToolDescription(name: string): string;
+export declare function isCatalogToolError(value: unknown): value is CatalogToolError;
+export declare function executeCatalogTool(
+  name: string,
+  args: unknown,
+  context: CatalogCallContext
+): Promise<unknown>;
+export declare function executeCatalogToolWithTrace(
+  name: string,
+  args: unknown,
+  context: CatalogCallContext
+): Promise<CatalogExecutionResult>;
+export declare function shapeMcpToolResult(name: string, value: unknown): unknown;
+
+export declare function runMcpServer(
+  apiUrlFlag?: string,
+  categories?: string,
+  workspaceIdFlag?: string
+): Promise<void>;