@inkeep/agents-run-api 0.0.0-dev-20250910232631

package/LICENSE.md

@@ -0,0 +1,49 @@
+# Inkeep SDK – Elastic License 2.0 with Supplemental Terms
+
+NOTE: The Inkeep SDK is licensed under the Elastic License 2.0 (ELv2), subject to Supplemental Terms included in [SUPPLEMENTAL_TERMS.md](SUPPLEMENTAL_TERMS.md). In the event of conflict, the Supplemental Terms control.
+
+# Elastic License 2.0
+
+## Acceptance  
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below.
+
+## Limitations
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+## Patents
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Notices
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+## No Other Rights
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+## Termination
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+## No Liability
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+The **licensor** is the entity offering these terms, and the **software** is the software the licensor makes available under these terms, including any portion of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.
+

package/README.md

@@ -0,0 +1,117 @@
+# Inkeep Execution API
+
+The Execution API is responsible for runtime agent operations, including Agent-to-Agent (A2A) communication, chat completions, and MCP (Model Context Protocol) tool integrations.
+
+## Overview
+
+This API handles the execution layer of the Inkeep Agent Framework:
+- **A2A Communication**: JSON-RPC based agent-to-agent communication following Google's A2A specification
+- **Chat Completions**: OpenAI-compatible chat API with multi-agent orchestration
+- **MCP Integration**: Model Context Protocol tools and external integrations
+- **Task Execution**: Real-time task processing and delegation workflows
+
+## Architecture
+
+### Core Components
+
+- **A2A Protocol**: Agent communication via JSON-RPC methods (`tasks/send`, `tasks/get`, `tasks/cancel`)
+- **Chat API**: OpenAI-compatible endpoints with agent routing and context preservation
+- **MCP Tools**: Dynamic tool discovery and execution from multiple transport types (stdio, SSE, HTTP)
+- **Task Management**: Hierarchical task execution with parent-child relationships
+
+### Key Features
+
+- **Context Preservation**: Maintains conversation state across agent transfers and delegations
+- **Multi-Agent Orchestration**: Hub-and-spoke and graph-based agent networks
+- **Real-time Communication**: WebSocket and HTTP-based agent interactions
+- **Tool Health Monitoring**: Automated health checks for external MCP tools
+
+## Development
+
+### Setup
+If you do not have the db setup:
+```bash 
+cd packages/core
+pnpm db:push
+```
+
+Then:
+```bash
+cd agents-run-api
+pnpm install
+```
+
+
+### Environment Variables
+```env
+ENVIRONMENT=development|production|test
+PORT=3003
+DB_FILE_NAME=path/to/sqlite.db
+ANTHROPIC_API_KEY=required
+OPENAI_API_KEY=optional
+LOG_LEVEL=debug|info|warn|error
+```
+
+### Development Commands
+```bash
+pnpm dev              # Start development server
+pnpm test             # Run test suite
+pnpm test:coverage    # Run tests with coverage
+pnpm build           # Build for production
+pnpm lint            # Run linting
+pnpm format          # Format code
+```
+
+### Testing
+All tests are located in `src/__tests__/` and use Vitest with 60-second timeouts for A2A interactions.
+
+```bash
+pnpm test                    # Run all tests
+pnpm test:coverage          # Run with coverage report
+pnpm test src/__tests__/a2a/ # Run A2A-specific tests
+```
+
+## Configuration
+
+The API uses environment-based configuration with defaults for local development. Key configuration areas:
+
+- **Database**: SQLite connection via `DB_FILE_NAME`
+- **AI Models**: Anthropic and OpenAI API keys
+- **Observability**: OpenTelemetry tracing support
+- **CORS**: Configurable for web clients
+
+## Integration
+
+### With Management API
+The Execution API reads agent configurations and relationships created by the Management API but doesn't modify them during runtime.
+
+### With MCP Tools
+Supports multiple MCP transport types:
+- **stdio**: Local process-based tools  
+- **SSE**: Server-sent events for streaming tools
+- **HTTP**: REST-based tool integrations
+
+### With Agent Builder
+Provides runtime execution for agents configured via the Agent Builder UI.
+
+## Observability
+
+- **Structured Logging**: JSON-formatted logs with correlation IDs
+- **OpenTelemetry**: Distributed tracing for agent interactions
+- **Health Checks**: Endpoint monitoring and tool availability
+- **Performance Metrics**: Request timing and success rates
+
+## Error Handling
+
+The API implements comprehensive error handling:
+- **Validation Errors**: Request schema validation
+- **Agent Errors**: Agent execution failures and timeouts
+- **Tool Errors**: MCP tool failures and recovery
+- **Network Errors**: Resilient communication patterns
+
+## Security
+
+- **API Key Authentication**: Configurable authentication methods
+- **Input Validation**: Request sanitization and type checking  
+- **CORS**: Configurable cross-origin policies
+- **Rate Limiting**: Configurable request throttling

package/dist/__tests__/setup.d.ts

@@ -0,0 +1,4 @@
+import { NodeSDK } from '@opentelemetry/sdk-node';
+declare const sdk: NodeSDK;
+export { sdk };
+//# sourceMappingURL=setup.d.ts.map

package/dist/__tests__/setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../../src/__tests__/setup.ts"],"names":[],"mappings":"AAqCA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAYlD,QAAA,MAAM,GAAG,SAgBP,CAAC;AA6BH,OAAO,EAAE,GAAG,EAAE,CAAC"}

package/dist/__tests__/setup.js

@@ -0,0 +1,80 @@
+import { vi } from 'vitest';
+// Mock the local logger module globally - this will be hoisted automatically by Vitest
+vi.mock('../logger.js', () => {
+    const mockLogger = {
+        info: vi.fn(),
+        warn: vi.fn(),
+        error: vi.fn(),
+        debug: vi.fn(),
+        child: vi.fn().mockReturnThis(),
+    };
+    return {
+        getLogger: vi.fn(() => mockLogger),
+        withRequestContext: vi.fn(async (_id, fn) => await fn()),
+    };
+});
+// Also mock the agents-core logger since api-key-auth imports from there
+vi.mock('@inkeep/agents-core', async (importOriginal) => {
+    const actual = await importOriginal();
+    const mockLogger = {
+        info: vi.fn(),
+        warn: vi.fn(),
+        error: vi.fn(),
+        debug: vi.fn(),
+        child: vi.fn().mockReturnThis(),
+    };
+    return {
+        ...actual,
+        getLogger: vi.fn(() => mockLogger),
+    };
+});
+import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto';
+import { ConsoleMetricExporter, PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
+/*instrumentation.ts*/
+import { NodeSDK } from '@opentelemetry/sdk-node';
+const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
+import { sql } from 'drizzle-orm';
+import { migrate } from 'drizzle-orm/libsql/migrator';
+import { afterAll, afterEach, beforeAll } from 'vitest';
+import dbClient from '../data/db/dbClient';
+import { getLogger } from '../logger';
+getLogger('Test Setup').debug({}, 'Setting up instrumentation');
+const sdk = new NodeSDK({
+    serviceName: 'inkeep-execution-api',
+    spanProcessors: [
+        new SimpleSpanProcessor(new OTLPTraceExporter({
+        // optional - default url is http://localhost:4318/v1/traces
+        // url: 'http://localhost:4318/v1/traces',
+        })),
+    ],
+    instrumentations: [getNodeAutoInstrumentations()],
+    // optional - default url is http://localhost:4318/v1/metrics
+    // url: 'http://localhost:4318/v1/metrics',
+    metricReader: new PeriodicExportingMetricReader({
+        exporter: new ConsoleMetricExporter(),
+    }),
+});
+sdk.start();
+// Initialize database schema for in-memory test databases using Drizzle migrations
+beforeAll(async () => {
+    const logger = getLogger('Test Setup');
+    try {
+        logger.debug({}, 'Applying database migrations to in-memory test database');
+        // Temporarily disable foreign key constraints for tests due to composite key issues
+        await dbClient.run(sql `PRAGMA foreign_keys = OFF`);
+        await migrate(dbClient, { migrationsFolder: '../packages/agents-core/drizzle' });
+        logger.debug({}, 'Database migrations applied successfully');
+    }
+    catch (error) {
+        logger.error({ error }, 'Failed to apply database migrations');
+        throw error;
+    }
+});
+afterEach(() => {
+    // Any cleanup if needed
+});
+afterAll(() => {
+    // Any final cleanup if needed
+});
+export { sdk };

package/dist/__tests__/utils/testProject.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Ensures a project exists for a given tenant ID.
+ * This is needed because of foreign key constraints in the database.
+ *
+ * @param tenantId - The tenant ID
+ * @param projectId - The project ID (defaults to 'default')
+ * @returns Promise that resolves when the project is created
+ */
+export declare function ensureTestProject(tenantId: string, projectId?: string): Promise<void>;
+/**
+ * Creates multiple test projects for a tenant.
+ *
+ * @param tenantId - The tenant ID
+ * @param projectIds - Array of project IDs to create
+ * @returns Promise that resolves when all projects are created
+ */
+export declare function ensureTestProjects(tenantId: string, projectIds: string[]): Promise<void>;
+//# sourceMappingURL=testProject.d.ts.map

package/dist/__tests__/utils/testProject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testProject.d.ts","sourceRoot":"","sources":["../../../src/__tests__/utils/testProject.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,SAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAK9F;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAE9F"}

package/dist/__tests__/utils/testProject.js

@@ -0,0 +1,26 @@
+import { sql } from 'drizzle-orm';
+import dbClient from '../../data/db/dbClient';
+/**
+ * Ensures a project exists for a given tenant ID.
+ * This is needed because of foreign key constraints in the database.
+ *
+ * @param tenantId - The tenant ID
+ * @param projectId - The project ID (defaults to 'default')
+ * @returns Promise that resolves when the project is created
+ */
+export async function ensureTestProject(tenantId, projectId = 'default') {
+    await dbClient.run(sql `
+    INSERT OR IGNORE INTO projects (tenant_id, id, name, description, created_at, updated_at)
+    VALUES (${tenantId}, ${projectId}, ${`Test Project ${projectId}`}, ${`Test project for ${projectId}`}, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)
+  `);
+}
+/**
+ * Creates multiple test projects for a tenant.
+ *
+ * @param tenantId - The tenant ID
+ * @param projectIds - Array of project IDs to create
+ * @returns Promise that resolves when all projects are created
+ */
+export async function ensureTestProjects(tenantId, projectIds) {
+    await Promise.all(projectIds.map((projectId) => ensureTestProject(tenantId, projectId)));
+}

package/dist/__tests__/utils/testRequest.d.ts

@@ -0,0 +1,8 @@
+export declare const makeRequest: (url: string, options?: RequestInit) => Promise<Response>;
+export declare const makeRequestWithContext: (url: string, context: {
+    tenantId?: string;
+    projectId?: string;
+    graphId?: string;
+    agentId?: string;
+}, options?: RequestInit) => Promise<Response>;
+//# sourceMappingURL=testRequest.d.ts.map

package/dist/__tests__/utils/testRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testRequest.d.ts","sourceRoot":"","sources":["../../../src/__tests__/utils/testRequest.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,WAAW,GAAU,KAAK,MAAM,EAAE,UAAS,WAAgB,sBAavE,CAAC;AAGF,eAAO,MAAM,sBAAsB,GACjC,KAAK,MAAM,EACX,SAAS;IACP,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,EACD,UAAS,WAAgB,sBAe1B,CAAC"}

package/dist/__tests__/utils/testRequest.js

@@ -0,0 +1,32 @@
+import app from '../../index';
+// Helper function to make requests with JSON headers and test authentication
+export const makeRequest = async (url, options = {}) => {
+    return app.request(url, {
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            Authorization: 'Bearer test-api-key',
+            'x-inkeep-tenant-id': 'test-tenant',
+            'x-inkeep-project-id': 'default',
+            'x-inkeep-graph-id': 'test-graph',
+            'x-test-bypass-auth': 'true',
+            ...options.headers,
+        },
+    });
+};
+// Helper function to make requests with custom execution context
+export const makeRequestWithContext = async (url, context, options = {}) => {
+    return app.request(url, {
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            Authorization: 'Bearer test-api-key',
+            'x-inkeep-tenant-id': context.tenantId || 'test-tenant',
+            'x-inkeep-project-id': context.projectId || 'test-project',
+            'x-inkeep-graph-id': context.graphId || 'test-graph',
+            'x-test-bypass-auth': 'true',
+            ...(context.agentId && { 'x-inkeep-agent-id': context.agentId }),
+            ...options.headers,
+        },
+    });
+};

package/dist/__tests__/utils/testTenant.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Creates a unique tenant ID for test isolation.
+ *
+ * Each test run gets its own tenant to ensure parallel tests don't interfere with each other.
+ * The generated tenant ID follows the format: test-tenant-{prefix}-{uuid} or test-tenant-{uuid}
+ *
+ * @param prefix - Optional prefix to include in the tenant ID (e.g., test file name)
+ * @returns A unique tenant ID for test isolation
+ *
+ * @example
+ * ```typescript
+ * import { createTestTenantId } from './utils/testTenant';
+ *
+ * describe('My test suite', () => {
+ *   const tenantId = createTestTenantId('agents');
+ *
+ *   it('should work with isolated tenant', async () => {
+ *     // Your test code using the unique tenant ID
+ *     console.log(tenantId); // e.g., "test-tenant-agents-123e4567-e89b-12d3-a456-426614174000"
+ *   });
+ * });
+ * ```
+ */
+export declare function createTestTenantId(prefix?: string): string;
+/**
+ * Creates multiple unique tenant IDs for test isolation.
+ *
+ * Useful when you need multiple tenants in a single test.
+ *
+ * @param count - Number of tenant IDs to generate
+ * @param prefix - Optional prefix to include in all tenant IDs
+ * @returns Array of unique tenant IDs
+ *
+ * @example
+ * ```typescript
+ * import { createTestTenantIds } from './utils/testTenant';
+ *
+ * describe('Multi-tenant test suite', () => {
+ *   const [tenantA, tenantB] = createTestTenantIds(2, 'multi-tenant');
+ *
+ *   it('should handle cross-tenant operations', async () => {
+ *     // Test operations across different tenants
+ *   });
+ * });
+ * ```
+ */
+export declare function createTestTenantIds(count: number, prefix?: string): string[];
+/**
+ * Checks if a tenant ID is a test tenant.
+ *
+ * @param tenantId - The tenant ID to check
+ * @returns True if the tenant ID is a test tenant
+ *
+ * @example
+ * ```typescript
+ * import { isTestTenant } from './utils/testTenant';
+ *
+ * const tenantId = createTestTenantId();
+ * console.log(isTestTenant(tenantId)); // true
+ * console.log(isTestTenant('production-tenant')); // false
+ * ```
+ */
+export declare function isTestTenant(tenantId: string): boolean;
+//# sourceMappingURL=testTenant.d.ts.map

package/dist/__tests__/utils/testTenant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testTenant.d.ts","sourceRoot":"","sources":["../../../src/__tests__/utils/testTenant.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAG1D;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAE5E;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEtD"}

package/dist/__tests__/utils/testTenant.js

@@ -0,0 +1,71 @@
+import { randomUUID } from 'node:crypto';
+/**
+ * Creates a unique tenant ID for test isolation.
+ *
+ * Each test run gets its own tenant to ensure parallel tests don't interfere with each other.
+ * The generated tenant ID follows the format: test-tenant-{prefix}-{uuid} or test-tenant-{uuid}
+ *
+ * @param prefix - Optional prefix to include in the tenant ID (e.g., test file name)
+ * @returns A unique tenant ID for test isolation
+ *
+ * @example
+ * ```typescript
+ * import { createTestTenantId } from './utils/testTenant';
+ *
+ * describe('My test suite', () => {
+ *   const tenantId = createTestTenantId('agents');
+ *
+ *   it('should work with isolated tenant', async () => {
+ *     // Your test code using the unique tenant ID
+ *     console.log(tenantId); // e.g., "test-tenant-agents-123e4567-e89b-12d3-a456-426614174000"
+ *   });
+ * });
+ * ```
+ */
+export function createTestTenantId(prefix) {
+    const uuid = randomUUID();
+    return prefix ? `test-tenant-${prefix}-${uuid}` : `test-tenant-${uuid}`;
+}
+/**
+ * Creates multiple unique tenant IDs for test isolation.
+ *
+ * Useful when you need multiple tenants in a single test.
+ *
+ * @param count - Number of tenant IDs to generate
+ * @param prefix - Optional prefix to include in all tenant IDs
+ * @returns Array of unique tenant IDs
+ *
+ * @example
+ * ```typescript
+ * import { createTestTenantIds } from './utils/testTenant';
+ *
+ * describe('Multi-tenant test suite', () => {
+ *   const [tenantA, tenantB] = createTestTenantIds(2, 'multi-tenant');
+ *
+ *   it('should handle cross-tenant operations', async () => {
+ *     // Test operations across different tenants
+ *   });
+ * });
+ * ```
+ */
+export function createTestTenantIds(count, prefix) {
+    return Array.from({ length: count }, () => createTestTenantId(prefix));
+}
+/**
+ * Checks if a tenant ID is a test tenant.
+ *
+ * @param tenantId - The tenant ID to check
+ * @returns True if the tenant ID is a test tenant
+ *
+ * @example
+ * ```typescript
+ * import { isTestTenant } from './utils/testTenant';
+ *
+ * const tenantId = createTestTenantId();
+ * console.log(isTestTenant(tenantId)); // true
+ * console.log(isTestTenant('production-tenant')); // false
+ * ```
+ */
+export function isTestTenant(tenantId) {
+    return tenantId.startsWith('test-tenant-');
+}