mcpField
T
typescript-sdk

typescript-sdk

github.com/inkeepAgent workflows1047 installsUpdated 21w ago
Repository

About typescript-sdk

A reference of rules for TypeScript SDK users defining agents, sub-agents, tools, and their relationships. It also covers MCP tool setup, CLI configuration, runtime limits, memory, and triggers.

Key features

  1. 01Define agents, sub-agents, and tools
  2. 02Configure sub-agent relationships
  3. 03Set up MCP tools and authentication
  4. 04Manage CLI and project configuration
  5. 05Configure runtime limits, memory, and triggers

Use cases

  1. 01Look up TypeScript agent configuration guidance
  2. 02Register and select MCP tools for agents
  3. 03Configure webhooks to invoke agents

MCP support

The documentation describes registering MCP servers as agent tools, selecting tools, and configuring authentication, overrides, and environment-specific settings.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/inkeep/skills --skill typescript-sdk

After installing, type/typescript-sdkin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

rules/
agent-relationships-overview.md
agent-relationships-when-to-use.md
artifact-components-definition.md
cli-add-command.md
cli-config-command.md
cli-config-file-structure.md
cli-dev-command.md
cli-environment-variables.md
cli-init-command.md
cli-list-agents-command.md
cli-login-command.md
cli-logout-command.md
cli-profile-command.md
cli-pull-command.md
cli-push-command.md
cli-update-command.md
config-hierarchy.md
context-fetchers-overview.md
credential-store-options.md
data-components-definition.md
data-operation-types.md
data-operations-overview.md
delegation-types.md
external-agents-overview.md
function-tools-execution.md
function-tools-overview.md
headers-passing-context.md
headers-usage.md
mcp-environment-aware.md
mcp-tool-auth.md

Details

From the project README

Typescript Sdk

Overview

The TypeScript SDK provides a declarative way to define agents, sub-agents, tools, and their relationships.

Rules (49)

Read individual rule files for detailed explanations and code examples on particular tasks or topics:

TitleTopicDescription
Sub Agent Relationships Overviewtypescript-sdk/agent-relationshipsTransfer and delegation relationships between Sub Agents
When to Use Transfers vs Delegationtypescript-sdk/agent-relationshipsGuidelines for choosing between transfer and delegation relationships
Types of Delegation Relationshipstypescript-sdk/agent-relationshipsSub agent, external agent, and team agent delegation
Configuring StopWhentypescript-sdk/agent-settingsControl stopping conditions to prevent infinite loops in agents
Sub Agent Parameters Referencetypescript-sdk/agent-settingsComplete parameter reference for subAgent() configuration
CLI inkeep add Commandtypescript-sdk/cli-referencePull a template project or MCP from the Inkeep Agents Cookbook
CLI inkeep config Commandtypescript-sdk/cli-referenceManage Inkeep configuration values
CLI Configuration File Structuretypescript-sdk/cli-referenceStructure of inkeep.config.ts and configuration priority
CLI inkeep dev Commandtypescript-sdk/cli-referenceStart the Inkeep dashboard server for visual agents orchestration
CLI Environment Variablestypescript-sdk/cli-referenceEnvironment variables respected by the CLI and SDK
CLI inkeep init Commandtypescript-sdk/cli-referenceInitialize a new Inkeep configuration file in your project
CLI inkeep list-agent Commandtypescript-sdk/cli-referenceList all available agents for a specific project
CLI inkeep login Commandtypescript-sdk/cli-referenceAuthenticate with a deployment using the device code flow
CLI inkeep logout Commandtypescript-sdk/cli-referenceClear stored credentials for a profile
CLI inkeep profile Commandtypescript-sdk/cli-referenceManage named CLI profiles for multiple remotes, credentials, and environments
CLI inkeep pull Commandtypescript-sdk/cli-referencePull project configuration from server and update local TypeScript files
CLI inkeep push Commandtypescript-sdk/cli-referencePush agent configurations to your server
CLI inkeep update Commandtypescript-sdk/cli-referenceUpdate the Inkeep CLI to the latest version
Runtime Limits Configurationtypescript-sdk/configure-runtime-limitsHow to configure execution limits, timeouts, and constraints
Runtime Configuration Variablestypescript-sdk/configure-runtime-limitsAll available environment variables for configuring runtime limits
Context Fetchers Overviewtypescript-sdk/context-fetchersHow to use context fetchers to embed real-time data in agent prompts
Credential Store Optionstypescript-sdk/credentials/overviewOptions for storing MCP server and external agent credentials
Data Operation Types Referencetypescript-sdk/data-operationsAll data operation event types and their payloads
Data Operations Overviewtypescript-sdk/data-operationsHow to enable and use data operations for debugging and monitoring
External Agents Overviewtypescript-sdk/external-agentsHow to configure and use external agents using the A2A protocol
Passing Context via Headerstypescript-sdk/headersHow to pass dynamic context to agents via HTTP headers
Using Headers in Agentstypescript-sdk/headersHow to use header values in prompts, context fetchers, and external tools
Conversation Memory Overviewtypescript-sdk/memoryHow conversation history is managed and included in context windows
Model Types Referencetypescript-sdk/modelsWhen to use each model type in the configuration hierarchy
Model Provider Optionstypescript-sdk/modelsConfiguration options for different model providers
Supported Models Referencetypescript-sdk/modelsList of supported model providers and their API keys
Defining Artifact Componentstypescript-sdk/structured-outputs/artifact-componentsHow to define artifact components with preview fields for citations and sources
Defining Data Componentstypescript-sdk/structured-outputs/data-componentsHow to define data components using Zod schemas
Status Updates Configurationtypescript-sdk/structured-outputs/status-updatesHow to configure AI-powered status updates for agents
Function Tools Execution Environmenttypescript-sdk/tools/function-toolsSandbox providers, runtime configuration, and security guarantees
Function Tools Overviewtypescript-sdk/tools/function-toolsUse cases and how to create function tools
Environment-Aware MCP Serverstypescript-sdk/tools/mcp-toolsConfigure MCP tools to switch based on environment (dev vs production)
MCP Tool Authenticationtypescript-sdk/tools/mcp-toolsAuthentication methods for MCP servers including API keys, OAuth, and custom headers
MCP Tool Overridestypescript-sdk/tools/mcp-toolsCustomize how individual MCP tools appear to agents
Selecting MCP Toolstypescript-sdk/tools/mcp-toolsHow to selectively enable tools from MCP servers
Registering MCP Servers as Toolstypescript-sdk/tools/mcp-toolsHow to register and configure MCP tools for your agents
Tool Approvals Configurationtypescript-sdk/tools/tool-approvalsHow to configure tools to require user approval before execution
Responding to Tool Approval Requeststypescript-sdk/tools/tool-approvalsHow to approve or deny tool execution requests
Trigger Configuration Optionstypescript-sdk/triggers/overviewConfiguration options for triggers including authentication, schemas, and transforms
Triggers Overviewtypescript-sdk/triggers/overviewCreating webhook endpoints to invoke agents from external services
Trigger Configuration Optionstypescript-sdk/triggers/webhooksConfiguration options for triggers including authentication, schemas, and transforms
Triggers Overviewtypescript-sdk/triggers/webhooksCreating webhook endpoints to invoke agents from external services
Configuration Priority Hierarchytypescript-sdk/workspace-configurationHow CLI flags, env vars, and config file values are resolved
Workspace Configuration Filetypescript-sdk/workspace-configurationStructure and options for inkeep.config.ts

Other Resources

For additional information, see:

Comments

Markdown supported