Corespeed Zypher

https://jsr.io/@corespeed/zypher/doc
Admin
Corespeed Zypher is an open-source agent framework for building production-ready agentic AI agents...
Tokens:135,658
Snippets:2,525
Trust Score:9.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Add Corespeed Zypher Package using Volt

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskCancelledEvent

Instructions for installing the Corespeed Zypher package with Volt. This includes the installation command and an example of importing a type from the package.

```bash
vlt install jsr:@corespeed/zypher

import { type TaskCancelledEvent } from "@corespeed/zypher";
```

--------------------------------

### Example Usage in Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/InputSchema

This snippet demonstrates how to import and potentially use the zypher-agent package within a Deno environment. It assumes the package is installed and available for import. No specific input or output is defined in this general import example.

```typescript
import {
  Agent,
  Tool,
  // other imports
} from "@corespeed/zypher";

// Example usage would follow here
```

--------------------------------

### Install @corespeed/zypher with Volt

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/BaseParams

Instructions to install the @corespeed/zypher package using Volt. This command adds the package to your Volt-managed project.

```bash
vlt install jsr:@corespeed/zypher
```

--------------------------------

### Install @corespeed/zypher with Yarn

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/BaseParams

Instructions to add the @corespeed/zypher package to your project using Yarn. This command fetches and installs the package.

```bash
yarn add jsr:@corespeed/zypher
```

--------------------------------

### Install @corespeed/zypher with bunx

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/BaseParams

Instructions to install the @corespeed/zypher package using bunx. This command runs the 'jsr add' command using bunx.

```bash
bunx jsr add @corespeed/zypher
```

--------------------------------

### Installation and Import

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/connectToRemoteServer

Instructions on how to add the Corespeed Zypher package using various package managers and how to import symbols.

```APIDOC
## Installation and Import

### Add Package

#### Using npm:
```bash
npm install jsr:@corespeed/zypher
```

#### Using pnpm:
```bash
pnpm i jsr:@corespeed/zypher
```

For pnpm versions 10.8 or older:
```bash
pnpm dlx jsr add @corespeed/zypher
```

#### Using yarn:
```bash
yarn add jsr:@corespeed/zypher
```

For yarn versions 4.8 or older:
```bash
yarn dlx jsr add @corespeed/zypher
```

#### Using vlt:
```bash
vlt install jsr:@corespeed/zypher
```

#### Using npx:
```bash
npx jsr add @corespeed/zypher
```

#### Using bunx:
```bash
bunx jsr add @corespeed/zypher
```

### Import Symbol

#### Example import:
```typescript
import { connectToRemoteServer } from "@corespeed/zypher";
```

#### Direct import with JSR specifier:
```typescript
import { connectToRemoteServer } from "jsr:@corespeed/zypher";
```
```

--------------------------------

### Add Zypher Package with bunx

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/FileNotFoundError

Installs the CoreSpeed Zypher package using `bunx`, the command-line tool for executing npm package binaries with Bun. The installation command is provided, along with an example import statement.

```bash
bunx jsr add @corespeed/zypher

import { FileNotFoundError } from "@corespeed/zypher";
```

--------------------------------

### Import ModelProviderOptions (Deno)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ModelProviderOptions

Example of importing the 'ModelProviderOptions' type from the Corespeed Zypher package in Deno. This import assumes the package is installed.

```typescript
import { type ModelProviderOptions } from "@corespeed/zypher";
```

--------------------------------

### Install @corespeed/zypher with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUseRejectedEvent

Instructions for adding the @corespeed/zypher package to your project using pnpm. This command installs the package and makes its symbols available for import.

```bash
pnpm i jsr:@corespeed/zypher
```

```bash
pnpm dlx jsr add @corespeed/zypher
# For pnpm 10.8 or older
```

--------------------------------

### Import Symbol with npm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/getSystemPrompt

Example of importing a symbol from the jsr package after installation with npm.

```javascript
import { getSystemPrompt } from "@corespeed/zypher";
```

--------------------------------

### Import ZypherContext (Deno)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ZypherContext

Example of importing the ZypherContext type from the @corespeed/zypher package in Deno. Assumes the package has been added.

```typescript
import { type ZypherContext } from "@corespeed/zypher";
```

--------------------------------

### Install @corespeed/zypher with bunx

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUseApprovedEvent

Installs the @corespeed/zypher package using bunx, the Bun package executor. This command adds the package to your project's dependencies.

```bash
bunx jsr add @corespeed/zypher

```

--------------------------------

### Install @corespeed/zypher with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/BaseParams

Instructions to install the @corespeed/zypher package using pnpm. This command adds the package as a dependency to your project.

```bash
pnpm i jsr:@corespeed/zypher
```

--------------------------------

### Install @corespeed/zypher with yarn

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUseRejectedEvent

Instructions for adding the @corespeed/zypher package to your project using yarn. This command installs the package and makes its symbols available for import.

```bash
yarn add jsr:@corespeed/zypher
```

```bash
yarn dlx jsr add @corespeed/zypher
# For Yarn 4.8 or older
```

--------------------------------

### createZypherContext

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/StreamChatParams

Creates a ZypherContext for the given working directory, consolidating workspace setup logic.

```APIDOC
## createZypherContext

### Description
Creates a ZypherContext for the given working directory. This function consolidates the workspace directory creation logic that was previously duplicated across the codebase.

### Function Signature
createZypherContext(workingDirectory: string): ZypherContext
```

--------------------------------

### Install @corespeed/zypher with npx

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/BaseParams

Instructions to install the @corespeed/zypher package using npx. This command executes the 'jsr add' command via npx.

```bash
npx jsr add @corespeed/zypher
```

--------------------------------

### Install @corespeed/zypher with Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/BaseParams

Instructions to add the @corespeed/zypher package to your Deno project. This command registers the package and makes its symbols available for import.

```bash
deno add jsr:@corespeed/zypher
```

--------------------------------

### Add Zypher Package with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/FileNotFoundError

Installs the CoreSpeed Zypher package using pnpm. It shows the standard installation command and an alternative command for older pnpm versions. Import examples are also provided.

```bash
pnpm i jsr:@corespeed/zypher

// or (using pnpm 10.8 or older)
pnpm dlx jsr add @corespeed/zypher

import { FileNotFoundError } from "@corespeed/zypher";
```

--------------------------------

### User Information and System Prompts

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/FileAttachmentCache

Utilities for getting user information and system prompts.

```APIDOC
## getCurrentUserInfo

### Description
Gets information about the current user's system environment.

### Function
`getCurrentUserInfo(): UserInfo`
```

```APIDOC
## getCustomRules

### Description
Reads custom rules from supported rule files in the current working directory. Searches for rule files in the following order and returns the first one found: .zypherrules, .cursorrules, .windsurfrules, CLAUDE.md, AGENTS.md.

### Function
`getCustomRules(): CustomRules`
```

```APIDOC
## getSystemPrompt

### Description
Generates the system prompt for the Zypher agent.

### Function
`getSystemPrompt(context: ZypherContext): string`
```

--------------------------------

### Import Symbol from @corespeed/zypher with Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/Base64ImageSource

Example of importing a type (e.g., Base64ImageSource) from the @corespeed/zypher package in Deno.

```typescript
import { type Base64ImageSource } from "@corespeed/zypher";
```

--------------------------------

### Install CoreSpeed Zypher with PNPM

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/ToolExecutionContext

Installs the CoreSpeed Zypher package using the PNPM package manager.

```bash
pnpm i jsr:@corespeed/zypher
```

```bash
pnpm dlx jsr add @corespeed/zypher
# (using pnpm 10.8 or older)
```

--------------------------------

### Add and Import @corespeed/zypher with bunx

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/convertServerDetailToEndpoint

Shows how to install the @corespeed/zypher package using bunx and import symbols. This method is specific to projects using the Bun runtime.

```bash
bunx jsr add @corespeed/zypher

```

```typescript
import { convertServerDetailToEndpoint } from "@corespeed/zypher";

```

--------------------------------

### Install @corespeed/zypher with npx

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUseApprovedEvent

Installs the @corespeed/zypher package using npx, which allows executing npm package binaries. This command adds the package to your project's dependencies.

```bash
npx jsr add @corespeed/zypher

```

--------------------------------

### Import Checkpoint Type with Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/Checkpoint

Example of importing the `Checkpoint` type from the CoreSpeed Zypher package in Deno. This demonstrates how to correctly reference types from the installed package in your Deno code.

```typescript
import { type Checkpoint } from "@corespeed/zypher";
```

--------------------------------

### Install CoreSpeed Zypher with Yarn

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/ToolExecutionContext

Installs the CoreSpeed Zypher package using the Yarn package manager.

```bash
yarn add jsr:@corespeed/zypher
```

```bash
yarn dlx jsr add @corespeed/zypher
# (using Yarn 4.8 or older)
```

--------------------------------

### Import ToolExecutionInterceptor with npm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ToolExecutionInterceptor

Example of importing the ToolExecutionInterceptor class from the Corespeed Zypher package when installed via npm. This allows for integration of custom tool execution logic.

```typescript
import { ToolExecutionInterceptor } from "@corespeed/zypher";
```

--------------------------------

### Install @corespeed/zypher with Vlt

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUseApprovedEvent

Installs the @corespeed/zypher package using the Vlt package manager. This command adds the package to your project's dependencies.

```bash
vlt install jsr:@corespeed/zypher

```

--------------------------------

### Zypher Agent - Run Task Example

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ProviderCapability

Demonstrates how to run a task using the ZypherAgent. It involves creating an agent instance and calling the 'runTask' method.

```typescript
// Assume agent is an instance of ZypherAgent
await agent.runTask("Your task description here");
```

--------------------------------

### Import TextBlock Symbol with Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TextBlock

Example of importing the TextBlock symbol from the @corespeed/zypher package in Deno. This demonstrates the standard import path for modules installed via JSR.

```typescript
import { type TextBlock } from "@corespeed/zypher";
```

--------------------------------

### Install @corespeed/zypher with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUseApprovedEvent

Installs the @corespeed/zypher package using the pnpm package manager. For older versions of pnpm, a dlx command is provided.

```bash
pnpm i jsr:@corespeed/zypher

```

```bash
pnpm dlx jsr add @corespeed/zypher

```

--------------------------------

### Import GrepSearchTool from corespeed/zypher

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/GrepSearchTool

Example of importing the GrepSearchTool from the tools module of the corespeed/zypher package using different import syntaxes.

```typescript
import { GrepSearchTool } from "@corespeed/zypher/tools";
```

```typescript
import { GrepSearchTool } from "jsr:@corespeed/zypher/tools";
```

--------------------------------

### Install @corespeed/zypher with pnpm (older versions)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/BaseParams

Instructions to install the @corespeed/zypher package using pnpm version 10.8 or older. This command uses 'dlx' to execute the 'jsr add' command.

```bash
pnpm dlx jsr add @corespeed/zypher
```

--------------------------------

### Tool Definitions

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/connectToRemoteServer

Details on available tools, including file operations, search, and terminal commands.

```APIDOC
## Tool Definitions

### Tool Interface

#### Description
Base interface for all tools.

#### Fields
- **description** (string) - A description of what the tool does.
- **execute** (function) - The function to execute the tool.
- **name** (string) - The name of the tool.
- **parameters** (object) - The JSON schema for the tool's input parameters.

### ToolExecutionContext Interface

#### Description
Execution context provided to tools.

#### Fields
- **workingDirectory** (string) - The current working directory for the tool.

### CopyFileTool

#### Description
Tool for copying files.

### DeleteFileTool

#### Description
Tool for deleting files.

### FileSearchTool

#### Description
Tool for searching files.

### GrepSearchTool

#### Description
Tool for performing grep searches.

### ListDirTool

#### Description
Tool for listing directory contents.

### ReadFileTool

#### Description
Tool for reading file contents.

### RunTerminalCmdTool

#### Description
Tool for running terminal commands.

### createEditFileTools

#### Description
Creates file editing tools with an optional backup directory.

### createImageTools

#### Description
Creates image tools with a specific OpenAI API key.

### createTool

#### Description
Helper function to create a tool with a simpler API.
```

--------------------------------

### Tools

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/runCommand

Documentation for the available tools, including file operations, search, and utility functions.

```APIDOC
## Tools

### Tool Interface

**Description**: Base interface for all tools.

**Fields**:
- `description` (string) - Description of the tool.
- `execute` (function) - The function to execute the tool.
- `name` (string) - The name of the tool.
- `parameters` (InputSchema) - The JSON schema for the tool's input parameters.

### Tool Execution Context

**Description**: Execution context provided to tools.

**Fields**:
- `workingDirectory` (string) - The current working directory for the tool execution.

### Input Schema

**Description**: JSON schema for a tool's input.

**Fields**:
- `properties` (object) - The properties of the input schema.
- `required` (array) - An array of required properties.
- `type` (string) - The type of the input schema (e.g., 'object').

### File Operations Tools

**Description**: Tools for interacting with the file system.

#### Copy File Tool

**Description**: Tool for copying files. No documentation available.

#### Delete File Tool

**Description**: Tool for deleting files. No documentation available.

#### List Directory Tool

**Description**: Tool for listing directory contents. No documentation available.

#### Read File Tool

**Description**: Tool for reading file contents. No documentation available.

### Search Tools

**Description**: Tools for searching within files or directories.

#### File Search Tool

**Description**: Tool for searching files. No documentation available.

#### Grep Search Tool

**Description**: Tool for performing grep-like searches. No documentation available.

### Utility Tools

**Description**: Utility functions and tools.

#### Create Edit File Tools

**Description**: Creates file editing tools with an optional backup directory.

#### Create Image Tools

**Description**: Creates image tools with a specific OpenAI API key.

#### Create Tool

**Description**: Helper function to create a tool with a simpler API.

#### Run Terminal Command Tool

**Description**: Tool for running commands in the terminal. No documentation available.
```

--------------------------------

### Add Zypher Package with Yarn

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/FileNotFoundError

Installs the CoreSpeed Zypher package using Yarn. It includes the primary installation command and a fallback for older Yarn versions. Examples demonstrate how to import symbols.

```bash
yarn add jsr:@corespeed/zypher

// or (using Yarn 4.8 or older)
yarn dlx jsr add @corespeed/zypher

import { FileNotFoundError } from "@corespeed/zypher";
```

--------------------------------

### Install @corespeed/zypher with Yarn

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUseApprovedEvent

Installs the @corespeed/zypher package using the Yarn package manager. For older versions of Yarn, a dlx command is provided.

```bash
yarn add jsr:@corespeed/zypher

```

```bash
yarn dlx jsr add @corespeed/zypher

```

--------------------------------

### Install @corespeed/zypher with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskMessageEvent

Installs the @corespeed/zypher package using pnpm. For versions 10.8 and older, `pnpm dlx jsr add` is used.

```bash
pnpm i jsr:@corespeed/zypher
```

```bash
pnpm dlx jsr add @corespeed/zypher

```

--------------------------------

### Install @corespeed/zypher with Yarn (older versions)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/BaseParams

Instructions to install the @corespeed/zypher package using Yarn version 4.8 or older. This command uses 'dlx' to execute the 'jsr add' command.

```bash
yarn dlx jsr add @corespeed/zypher
```

--------------------------------

### Install @corespeed/zypher with yarn

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskMessageEvent

Installs the @corespeed/zypher package using yarn. For versions 4.8 and older, `yarn dlx jsr add` is used.

```bash
yarn add jsr:@corespeed/zypher
```

```bash
yarn dlx jsr add @corespeed/zypher

```

--------------------------------

### Add and Import @corespeed/zypher with Vlt

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/convertServerDetailToEndpoint

Illustrates how to install the @corespeed/zypher package using the Vlt package manager and import the necessary symbols.

```bash
vlt install jsr:@corespeed/zypher

```

```typescript
import { convertServerDetailToEndpoint } from "@corespeed/zypher";

```

--------------------------------

### Import getCustomRules from @corespeed/zypher in Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/getCustomRules

Example of importing the 'getCustomRules' function from the @corespeed/zypher package in Deno. Assumes the package has been added.

```typescript
import { getCustomRules } from "@corespeed/zypher";
```

--------------------------------

### Zypher Context Creation

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/AnthropicModelProvider

Function for creating and managing the Zypher context, which includes workspace setup.

```APIDOC
## Zypher Context Creation

### Description
Function for creating and managing the Zypher context, which includes workspace setup.

### Function
#### `createZypherContext(workingDirectory: string): ZypherContext`
Creates a ZypherContext for the given working directory. This function consolidates the workspace directory creation logic that was previously duplicated across the codebase.
```

--------------------------------

### Zypher Context and Configuration

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/UserInfo

Utilities for creating and managing Zypher context, including system prompts and custom rules.

```APIDOC
## Zypher Context and Configuration

### createZypherContext

Creates a ZypherContext for the given working directory. This function consolidates the workspace directory creation logic that was previously duplicated across the codebase.

### Method
`f` (Function)

### getCustomRules

Reads custom rules from supported rule files in the current working directory. Searches for rule files in the following order and returns the first one found: .zypherrules, .cursorrules, .windsurfrules, CLAUDE.md, AGENTS.md.

### Method
`f` (Function)

### getSystemPrompt

Generates the system prompt for the Zypher agent.

### Method
`f` (Function)
```

--------------------------------

### Import FileSearchTool in PNPM

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/FileSearchTool

Example of importing the FileSearchTool from the @corespeed/zypher package when using PNPM.

```typescript
import { FileSearchTool } from "@corespeed/zypher/tools";
```

--------------------------------

### Add and Import @corespeed/zypher with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/convertServerDetailToEndpoint

Shows how to install the @corespeed/zypher package using pnpm. It includes instructions for both newer versions (pnpm i) and older versions (pnpm dlx jsr add).

```bash
pnpm i jsr:@corespeed/zypher

```

```bash
pnpm dlx jsr add @corespeed/zypher

```

```typescript
import { convertServerDetailToEndpoint } from "@corespeed/zypher";

```

--------------------------------

### Import FileSearchTool in Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/FileSearchTool

Example of importing the FileSearchTool from the @corespeed/zypher package in Deno, using both scoped and direct JSR specifiers.

```typescript
import { FileSearchTool } from "@corespeed/zypher/tools";

// or

import { FileSearchTool } from "jsr:@corespeed/zypher/tools";
```

--------------------------------

### Import ReadFileTool with npm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/ReadFileTool

Example of importing the ReadFileTool after adding the package with npm. This demonstrates how to access specific tools from the library.

```typescript
import { ReadFileTool } from "@corespeed/zypher/tools";
```

--------------------------------

### Import Symbol using npm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ContentBlock

Example of importing a type or symbol from the @corespeed/zypher package after installation with npm.

```typescript
import { type ContentBlock } from "@corespeed/zypher";
```

--------------------------------

### Add Corespeed Zypher Package using Bun

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskCancelledEvent

Instructions for adding the Corespeed Zypher package using Bun. It shows the command to add the package and an example of how to import a type.

```bash
bunx jsr add @corespeed/zypher

import { type TaskCancelledEvent } from "@corespeed/zypher";
```

--------------------------------

### Import Symbol from Corespeed Zypher (Deno)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/getCurrentUserInfo

Example of how to import symbols, specifically 'getCurrentUserInfo', from the Corespeed Zypher package after installation with Deno.

```typescript
import { getCurrentUserInfo } from "@corespeed/zypher";
```

--------------------------------

### Import TaskToolUseRejectedEvent with npm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUseRejectedEvent

Example of how to import the TaskToolUseRejectedEvent type from the @corespeed/zypher package when installed via npm. This allows you to use the type in your TypeScript or JavaScript code.

```typescript
import { type TaskToolUseRejectedEvent } from "@corespeed/zypher";
```

--------------------------------

### Server Connections

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/UploadOptions

Functions for establishing connections to CLI and remote servers.

```APIDOC
## connectToCliServer

### Description
Connects to a CLI-based MCP server using stdio transport

### Method
GET

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A

## connectToRemoteServer

### Description
Connects to a remote MCP server with automatic transport fallback

### Method
GET

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A

## connectToServer

### Description
Connects to an MCP server using the appropriate transport based on endpoint configuration

### Method
GET

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A
```

--------------------------------

### Import UploadOptions (npm)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/UploadOptions

Example of importing the UploadOptions type from the Corespeed Zypher package using npm.

```typescript
import { type UploadOptions } from "@corespeed/zypher";
```

--------------------------------

### Initialize and Use Zypher Agent SDK

Source: https://jsr.io/@corespeed/zypher/doc/@corespeed/zypher

Demonstrates initializing the Zypher Agent SDK with a context and model provider, registering tools, and running a task. It requires environment variables for API keys and specifies the model to use. The output is streamed as text events.

```typescript
import {
  AnthropicModelProvider,
  createZypherContext,
  EditFileTool,
  ReadFileTool,
  ZypherAgent,
} from "@corespeed/zypher";

// Initialize context and provider
const context = await createZypherContext("/path/to/workspace");
const provider = new AnthropicModelProvider({
  apiKey: Deno.env.get("ANTHROPIC_API_KEY")!,
});

// Create agent
const agent = new ZypherAgent(context, provider);

// Register tools
agent.mcp.registerTool(ReadFileTool);
agent.mcp.registerTool(EditFileTool);

// Run task with streaming
const taskEvents = agent.runTask(
  "Implement authentication middleware",
  "claude-sonnet-4-20250514",
);

for await (const event of taskEvents) {
  if (event.type === "text") {
    console.log(event.content);
  }
}



```

--------------------------------

### Install Zypher Agent Package

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskEvent

Add the @corespeed/zypher package to your project using various package managers. Supports Deno, npm, pnpm, yarn, vlt, and bun with JSR registry.

```bash
deno add jsr:@corespeed/zypher
```

```bash
pnpm i jsr:@corespeed/zypher
```

```bash
pnpm dlx jsr add @corespeed/zypher
```

```bash
yarn add jsr:@corespeed/zypher
```

```bash
yarn dlx jsr add @corespeed/zypher
```

```bash
vlt install jsr:@corespeed/zypher
```

```bash
npx jsr add @corespeed/zypher
```

```bash
bunx jsr add @corespeed/zypher
```

--------------------------------

### Import Symbol using Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskHistoryChangedEvent

Example of importing a type from the @corespeed/zypher package in Deno.

```typescript
import { type TaskHistoryChangedEvent } from "@corespeed/zypher";
```

--------------------------------

### OpenAIModelProviderOptions

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/S3StorageService

Options for configuring the OpenAIModelProvider.

```APIDOC
## OpenAIModelProviderOptions

### Description
Options for configuring the OpenAIModelProvider.

### Properties
- `openaiClientOptions` (object): Options for the OpenAI client.
- `reasoningEffort` (number): The reasoning effort to apply.
```

--------------------------------

### Import Symbol from @corespeed/zypher with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/OAuthCallbackHandler

Example of importing a symbol from the @corespeed/zypher package after it has been installed with pnpm. This assumes the package is correctly linked in your `node_modules`.

```typescript
import { type OAuthCallbackHandler } from "@corespeed/zypher";
```

--------------------------------

### Import ZypherAgent with npm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ZypherAgent

Example of importing the ZypherAgent from the @corespeed/zypher package after installation via npm. This allows you to instantiate and use the agent in your TypeScript or JavaScript code.

```typescript
import { ZypherAgent } from "@corespeed/zypher";
```

--------------------------------

### SystemPromptLoader Function

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/GrepSearchTool

Loads the system prompt for the agent, allowing for custom prompt loading logic.

```APIDOC
## SystemPromptLoader Function

### Description
Function that loads the system prompt for the agent. This allows developers to implement custom prompt loading logic, such as reading from files, fetching from APIs, or computing dynamically.

### Usage
`loadSystemPrompt()`

Returns:
- `Promise<string>`: A promise that resolves to the system prompt string.
```

--------------------------------

### Install Zypher Agent using JSR

Source: https://jsr.io/@corespeed/zypher/doc/@corespeed/zypher

This snippet shows how to install the Zypher Agent package in a Deno project using JSR. Ensure your Deno project is set up to import packages from JSR.

```typescript
# In your Deno project: 
import { ZypherAgent } from "jsr:@corespeed/zypher@^0.4.2";



```

--------------------------------

### Instantiate OpenAIModelProvider

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/OpenAIModelProvider

Demonstrates how to create an instance of the OpenAIModelProvider. Requires OpenAIModelProviderOptions as input. This is a key step for integrating OpenAI capabilities into your agent.

```typescript
const provider = new OpenAIModelProvider({
  apiKey: "YOUR_OPENAI_API_KEY"
});
```

--------------------------------

### Import Symbol using Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/McpServerEndpoint

Example of importing a symbol, specifically McpServerEndpoint, using the Deno import syntax.

```typescript
import { type McpServerEndpoint } from "@corespeed/zypher";
```

--------------------------------

### Import Completer from Corespeed Zypher (pnpm)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/Completer

Example of importing the 'Completer' symbol from the Corespeed Zypher package.

```typescript
import { Completer } from "@corespeed/zypher";
```

--------------------------------

### SystemPromptLoader

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/S3StorageService

Functionality for loading system prompts for the agent, allowing custom loading logic.

```APIDOC
## SystemPromptLoader

### Description
Function that loads the system prompt for the agent. This allows developers to implement custom prompt loading logic, such as reading from files, fetching from APIs, or computing dynamically.
```

--------------------------------

### Import Symbol directly with JSR specifier

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ContentBlock

Example of importing a type or symbol directly using the JSR specifier, bypassing local installation.

```typescript
import { type ContentBlock } from "jsr:@corespeed/zypher";
```

--------------------------------

### Import BaseParams from @corespeed/zypher with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/BaseParams

Example of importing the BaseParams type from the @corespeed/zypher package after installation with pnpm. This demonstrates how to reference the type in your code.

```typescript
import { type BaseParams } from "@corespeed/zypher/tools";
```

--------------------------------

### Import from @corespeed/zypher in Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/FinalMessage

Example of importing a specific type, 'FinalMessage', from the @corespeed/zypher package in Deno. This demonstrates how to reference symbols from installed JSR packages.

```typescript
import { type FinalMessage } from "@corespeed/zypher";
```

--------------------------------

### McpClientOptions

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/S3StorageService

Configuration options for the McpClient.

```APIDOC
## McpClientOptions

### Description
Client-specific configuration options.

### Properties
- `name` (string): The name of the client.
- `version` (string): The version of the client.
```

--------------------------------

### Agent Configuration and Utilities

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/OpenAIModelProviderOptions

Documentation for configuring the Zypher agent and related utility classes.

```APIDOC
## Agent Configuration and Utilities

### ZypherAgent

Represents the main Zypher agent.

#### Methods
- **runTask**(task: string) - Runs a given task.
- **isTaskRunning**() - Checks if a task is currently running.
- **clearMessages**() - Clears the agent's message history.
- **applyCheckpoint**(id: string) - Applies a checkpoint.
- **wait**(ms: number) - Waits for a specified duration.

### ZypherAgentConfig

Configuration options for the Zypher agent.

#### Fields
- **maxIterations** (number) - Maximum number of iterations for the agent.
- **maxTokens** (number) - Maximum number of tokens the agent can use.
- **taskTimeoutMs** (number) - Timeout for task execution in milliseconds.

### ZypherAgentOptions

Options for initializing the Zypher agent.

#### Fields
- **config** (ZypherAgentConfig) - Agent configuration.
- **overrides** (object) - Overrides for agent behavior.
- **checkpointManager** (object) - Checkpoint management service.
- **storageService** (object) - Storage service for the agent.

### ZypherContext

Represents the workspace and filesystem environment where the agent operates.

#### Fields
- **userId** (string) - The ID of the user.
- **workspacePath** (string) - The path to the workspace.
- **workingDirectory** (string) - The current working directory.
- **zypherDir** (string) - The directory for Zypher-specific files.
- **fileAttachmentCacheDir** (string) - Directory for caching file attachments.
- **workspaceDataDir** (string) - Directory for workspace data.

### UserInfo

Information about the user's system environment.

#### Fields
- **osVersion** (string) - The operating system version.
- **shell** (string) - The user's shell.
- **workspacePath** (string) - The path to the workspace.

### Upload Options and Result

#### UploadOptions

Options for uploading a file.

#### Fields
- **filename** (string) - The name of the file to upload.
- **contentType** (string) - The content type of the file.
- **size** (number) - The size of the file in bytes.
- **metadata** (object) - Additional metadata for the upload.
- **urlExpirySeconds** (number) - The expiry time for the upload URL in seconds.

#### UploadResult

Result of a successful file upload.

#### Fields
- **id** (string) - The unique identifier for the uploaded file.
- **url** (string) - The URL to access the uploaded file.
- **expiresAt** (string) - The expiration timestamp of the URL.
- **metadata** (object) - Metadata associated with the uploaded file.

### Image Source

#### UrlImageSource

URL image source.

#### Fields
- **url** (string) - The URL of the image.
- **mediaType** (string) - The media type of the image (e.g., 'image/png').
- **type** (string) - The source type, expected to be 'url'.

```

--------------------------------

### Import ModelProviderOptions (JSR Specifier)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ModelProviderOptions

Example of importing the 'ModelProviderOptions' type directly using a JSR specifier in TypeScript. This method is useful for direct import without prior installation.

```typescript
import { type ModelProviderOptions } from "jsr:@corespeed/zypher";
```

--------------------------------

### Import McpServerManager with Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/McpServerManager

Imports the McpServerManager symbol from the CoreSpeed Zypher package when installed with Deno.

```typescript
import { McpServerManager } from "@corespeed/zypher";
```

--------------------------------

### Add Zypher Package with Deno

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/FileNotFoundError

Installs the CoreSpeed Zypher package using Deno's package management system. This command adds the package and provides an example of how to import symbols, such as `FileNotFoundError`, directly from the JSR specifier.

```bash
deno add jsr:@corespeed/zypher

import { FileNotFoundError } from "jsr:@corespeed/zypher";
```

--------------------------------

### OpenAIModelProviderOptions

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/createImageTools

Options for configuring the OpenAIModelProvider.

```APIDOC
## Interface OpenAIModelProviderOptions

### Description
No documentation available

### Properties
- **openaiClientOptions** (any) - 
- **reasoningEffort** (any) - 
```

--------------------------------

### Get File Attachment Cache Path (TypeScript)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/FileAttachmentManager

Returns the local file system path where a specific file attachment is cached. This method is useful for directly accessing cached files on disk, for example, when integrating with other file-based operations or tools.

```TypeScript
getFileAttachmentCachePath(fileId: string): string
```

--------------------------------

### OpenAIModelProvider

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/createImageTools

Concrete implementation of ModelProvider for OpenAI.

```APIDOC
## Class OpenAIModelProvider

### Description
No documentation available

### Properties
- **info** (any) - 
- **streamChat** (any) - 
```

--------------------------------

### Import Completer from Corespeed Zypher (Deno)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/Completer

Example of importing the 'Completer' symbol from the Corespeed Zypher package using a JSR specifier.

```typescript
import { Completer } from "jsr:@corespeed/zypher";
```

--------------------------------

### Agent and Configuration

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/runCommand

Details about the Zypher agent, its configuration, and related options.

```APIDOC
## Agent and Configuration

### Tool Execution Interceptor

**Description**: Interceptor that handles tool execution when the LLM requests tool calls.

**Methods**:
- `intercept` (function) - The function to intercept tool execution.

**Fields**:
- `description` (string) - Description of the interceptor.
- `name` (string) - Name of the interceptor.

### TypeScript Error Detector

**Description**: Detector for TypeScript compiler errors.

**Methods**:
- `detect` (function) - Detects TypeScript errors.
- `determineCommand` (function) - Determines the command to run.
- `filterNonErrors` (function) - Filters out non-error output.
- `isApplicable` (function) - Checks if the detector is applicable.

**Fields**:
- `description` (string) - Description of the detector.
- `name` (string) - Name of the detector.

### Zypher Agent

**Description**: Represents the core Zypher agent.

**Methods**:
- `applyCheckpoint` (function) - Applies a checkpoint.
- `clearMessages` (function) - Clears agent messages.
- `runTask` (function) - Runs a task.
- `wait` (function) - Waits for a task to complete.

**Fields**:
- `config` (ZypherAgentConfig) - Agent configuration.
- `isTaskRunning` (boolean) - Flag indicating if a task is running.
- `loopInterceptor` (object) - Interceptor for the agent's loop.
- `mcp` (object) - Message Control Plane.
- `messages` (array) - List of messages.

### Zypher Agent Config

**Description**: Configuration options for the Zypher agent.

**Fields**:
- `maxIterations` (number) - Maximum number of iterations.
- `maxTokens` (number) - Maximum number of tokens.
- `taskTimeoutMs` (number) - Timeout for tasks in milliseconds.

### Zypher Agent Options

**Description**: Options for initializing the Zypher agent.

**Fields**:
- `checkpointManager` (object) - Checkpoint management service.
- `config` (ZypherAgentConfig) - Agent configuration.
- `overrides` (object) - Configuration overrides.
- `storageService` (object) - Storage service for the agent.
```

--------------------------------

### Add jsr Package with npm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/ReadFileTool

Instructions for adding the jsr package using npm. This command installs the package and makes its symbols available for import.

```bash
npm add jsr:@corespeed/zypher
```

--------------------------------

### McpClientOptions

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/createImageTools

Client-specific configuration options for McpClient.

```APIDOC
## Interface McpClientOptions

### Description
Client-specific configuration options

### Properties
- **name** (any) - 
- **version** (any) - 
```

--------------------------------

### Import Directly with JSR Specifier

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/Base64ImageSource

Demonstrates importing symbols directly using the 'jsr:' specifier, applicable across various environments.

```typescript
import { type Base64ImageSource } from "jsr:@corespeed/zypher";
```

--------------------------------

### Add @corespeed/zypher Package with vltr

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ZypherAgent

Instructions for adding the @corespeed/zypher package using vltr. This command installs the package and makes it available for import in your project.

```bash
vltr install jsr:@corespeed/zypher
```

--------------------------------

### SystemPromptLoader

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/createImageTools

Function that loads the system prompt for the agent.

```APIDOC
## Type SystemPromptLoader

### Description
Function that loads the system prompt for the agent. This allows developers to implement custom prompt loading logic, such as reading from files, fetching from APIs, or computing dynamically.
```

--------------------------------

### ToolExecutionInterceptor Class

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/ToolExecutionInterceptor

Documentation for the ToolExecutionInterceptor class, including its constructors, properties, and methods.

```APIDOC
## ToolExecutionInterceptor

Interceptor that handles tool execution when the LLM requests tool calls.

### Constructors

`new ToolExecutionInterceptor(mcpServerManager: McpServerManager, handleToolApproval?: ToolApprovalHandler)`

- **mcpServerManager** (McpServerManager) - Required - The server manager for MCP.
- **handleToolApproval** (ToolApprovalHandler) - Optional - A handler for tool approval.

### Properties

- `description` (string) - Readonly - Description of the interceptor.
- `name` (string) - Readonly - Name of the interceptor.

### Methods

`intercept(context: InterceptorContext): Promise<InterceptorResult>`

- **context** (InterceptorContext) - The context for the interception.
- Returns a Promise that resolves to an InterceptorResult.
```

--------------------------------

### Add jsr Package with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/S3StorageService

Command to add the jsr package using pnpm. This command installs the specified package from the JSR registry.

```bash
pnpm add jsr:@corespeed/zypher
```

--------------------------------

### getSystemPrompt

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUseRejectedEvent

Generates the system prompt for the Zypher agent.

```APIDOC
## getSystemPrompt

### Description
Generates the system prompt for the Zypher agent, which typically includes initial instructions and context.

### Method
`getSystemPrompt()`
```

--------------------------------

### OpenAIModelProvider

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/S3StorageService

Concrete implementation of ModelProvider for OpenAI models.

```APIDOC
## OpenAIModelProvider

### Description
Concrete implementation of ModelProvider for OpenAI models.

### Methods
- `info()`: Returns information about the OpenAI model provider.
- `streamChat(params)`: Streams chat completions using the OpenAI API.
```

--------------------------------

### Add jsr Package with pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/ReadFileTool

Instructions for adding the jsr package using pnpm. This command installs the package and makes its symbols available for import.

```bash
pnpm i jsr:@corespeed/zypher
```

```bash
pnpm dlx jsr add @corespeed/zypher
```

--------------------------------

### McpCommandConfig

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/createImageTools

Command configuration for local MCP server execution.

```APIDOC
## Interface McpCommandConfig

### Description
Command configuration for local MCP server execution

### Properties
- **args** (any) - 
- **command** (any) - 
- **env** (any) - 
```

--------------------------------

### Add Corespeed Zypher Package using pnpm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/StorageService

Instructions for adding the Corespeed Zypher package to your project using pnpm. This command installs the latest version of the package from the JSR registry.

```bash
pnpm i jsr:@corespeed/zypher

```

```bash
pnpm dlx jsr add @corespeed/zypher
```

--------------------------------

### Add jsr Package with npm

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/RunTerminalCmdTool

Instructions for adding the jsr package using npm. This command installs the package and makes its symbols available for import.

```bash
npm install jsr:@corespeed/zypher
```

--------------------------------

### Tools

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/OAuthOptions

Documentation for the various tools available within the Zypher ecosystem.

```APIDOC
## Tools

### Tool Interface

Base interface for all tools.

*   **description** (string) - A description of what the tool does.
*   **execute** (function) - The function to execute the tool's logic.
*   **name** (string) - The unique name of the tool.
*   **parameters** (InputSchema) - The JSON schema defining the tool's input parameters.

### ToolExecutionContext

Execution context provided to tools during their execution.

*   **workingDirectory** (string) - The current working directory for the tool execution.

### File Tools

*   **CopyFileTool**
    No documentation available.
*   **DeleteFileTool**
    No documentation available.
*   **FileSearchTool**
    No documentation available.
*   **GrepSearchTool**
    No documentation available.
*   **ListDirTool**
    No documentation available.
*   **ReadFileTool**
    No documentation available.
*   **RunTerminalCmdTool**
    No documentation available.

### Tool Creation Helpers

*   **createEditFileTools**
    Create file editing tools with an optional backup directory.
*   **createImageTools**
    Create image tools with a specific OpenAI API key.
*   **createTool**
    Helper function to create a tool with a simpler API.

### InputSchema

Defines the JSON schema for a tool's input.

*   **properties** (object) - An object defining the properties of the input.
*   **required** (array) - An array of strings listing the required input fields.
*   **type** (string) - The type of the input, typically 'object'.
```

--------------------------------

### Add jsr package with Vlt

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/TaskToolUsePendingApprovalEvent

This snippet demonstrates how to install the @corespeed/zypher package using the Vlt package manager. After installation, you can import symbols from the package.

```shell
vlt install jsr:@corespeed/zypher

import { type TaskToolUsePendingApprovalEvent } from "@corespeed/zypher";
```

--------------------------------

### McpCommandConfig

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/S3StorageService

Configuration for executing commands locally with an MCP server.

```APIDOC
## McpCommandConfig

### Description
Command configuration for local MCP server execution.

### Properties
- `args` (string[]): Arguments for the command.
- `command` (string): The command to execute.
- `env` (object): Environment variables for the command.
```

--------------------------------

### S3Options

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/createImageTools

S3-specific provider options.

```APIDOC
## Interface S3Options

### Description
S3-specific provider options

### Properties
- **bucket** (any) - 
- **credentials** (any) - 
- **customDomain** (any) - 
- **endpoint** (any) - 
- **region** (any) - 
```

--------------------------------

### McpServerManager API

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/GrepSearchTool

Manages MCP (Model Context Protocol) servers and their tools. Handles server registration, tool management, and configuration persistence.

```APIDOC
## McpServerManager API

### Description
McpServerManager is a class that manages MCP (Model Context Protocol) servers and their tools. It handles server registration, tool management, and configuration persistence.

### Properties
- `debugLogState` (boolean): Controls whether debug logging is enabled.
- `servers` (object): An object containing registered MCP servers.
- `tools` (object): An object containing registered tools.

### Methods
- `cleanup()`: Cleans up resources used by the server manager.
- `deregisterServer(name)`: Deregisters an MCP server by its name.
- `getTool(name)`: Retrieves a tool by its name across all registered servers.
- `listRegistryServers()`: Lists available servers in the registry.
- `registerServer(config)`: Registers a new MCP server.
- `registerServerFromRegistry(name)`: Registers an MCP server from the registry.
- `registerTool(tool)`: Registers a tool with the server manager.
- `updateServer(name, config)`: Updates the configuration of an existing MCP server.
```

--------------------------------

### OpenAIModelProvider Class

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/tools/~/GrepSearchTool

A concrete implementation of the ModelProvider interface for OpenAI's language models.

```APIDOC
## OpenAIModelProvider Class

### Description
Provides an implementation for interacting with OpenAI's language models.

### Methods
- `info()`: Returns information about the OpenAI model provider.
- `streamChat(params)`: Initiates a streaming chat completion request using the OpenAI API.
```

--------------------------------

### Add Corespeed Zypher Package (pnpm)

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/UploadOptions

Instructions for adding the Corespeed Zypher package to your project using pnpm.

```bash
pnpm i jsr:@corespeed/zypher
```

```bash
pnpm dlx jsr add @corespeed/zypher
(for pnpm 10.8 or older)
```

--------------------------------

### Add @corespeed/zypher using Vlt

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/McpRemoteConfig

This snippet shows how to add the @corespeed/zypher package using the Vlt package manager. It includes the installation command and the corresponding import statement.

```bash
vlt install jsr:@corespeed/zypher
```

```typescript
import { type McpRemoteConfig } from "@corespeed/zypher";
```

--------------------------------

### Checkpoint Management

Source: https://jsr.io/@corespeed/zypher/doc/%40corespeed/zypher/doc/~/UploadOptions

Utilities for managing and applying checkpoints.

```APIDOC
## Checkpoint

### Description
Checkpoint information

### Fields
  * files
  * id
  * name
  * timestamp

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A

## CheckpointManager

### Description
Gets the path to the checkpoints directory for the current workspace

### Methods
  * applyCheckpoint
  * createCheckpoint
  * getCheckpointDetails
  * listCheckpoints

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A
```
Tokens:
Raw