@inkeep/agents-manage-api 0.0.0-chat-to-edit-20251119071712

package/LICENSE.md

@@ -0,0 +1,56 @@
+<!--
+AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+Source: ./LICENSE.md
+This file is automatically copied from the root LICENSE.md during build.
+Any changes should be made to the root LICENSE.md file.
+-->
+
+# 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,174 @@
+# Inkeep Agents Manage API
+
+The Agents Manage API is responsible for entity management and CRUD operations for the Inkeep Agent Framework. It provides the administrative layer for creating, configuring, and managing agents, graphs, tools, and projects.
+
+## Overview
+
+This API handles the configuration and management layer:
+- **Entity Management**: CRUD operations for all framework entities
+- **Agent Configuration**: Agent creation, updates, and relationship management  
+- **Graph Management**: Agent graph definitions and topology
+- **Tool Management**: MCP tool registration and configuration
+- **Project Management**: Multi-tenant project organization
+
+## Architecture
+
+### Core Entities
+
+- **Projects**: Top-level organizational units with tenant scoping
+- **Agents**: Individual AI agents with instructions and capabilities
+- **Agent Graphs**: Collections of agents with defined relationships
+- **Agent Relations**: Transfer and delegation relationships between agents
+- **Tools**: MCP servers and hosted tool configurations
+- **Tasks**: Work units with hierarchical parent-child relationships
+
+## Development
+
+### Setup
+
+```bash
+cd agents-run-api
+pnpm install
+```
+
+If you do not have the database setup, run migrations from the monorepo root:
+
+```bash
+pnpm db:migrate
+```
+
+### Environment Variables
+```env
+ENVIRONMENT=development|production|test
+PORT=3002
+DATABASE_URL=pg_db_url
+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
+```
+
+### Database Operations
+```bash
+pnpm db:generate     # Generate migration files from schema changes
+pnpm db:migrate      # Apply migration files to database
+pnpm db:studio       # Open Drizzle Studio for inspection
+```
+
+## Builder Patterns
+
+The API provides builder patterns for programmatic entity creation:
+
+### Agent Builder
+```typescript
+import { agent } from '@inkeep/agents-manage-api';
+
+const qaAgent = agent({
+  id: 'qa-agent',
+  name: 'QA Agent',
+  instructions: 'Answer questions about our product',
+  canTransferTo: () => [routerAgent],
+  canDelegateTo: () => [searchAgent],
+  tools: { search: searchTool }
+});
+```
+
+### Agent Builder
+```typescript
+import { agent } from '@inkeep/agents-sdk';
+
+const myAgent = agent({
+  id: 'customer-support',
+  name: 'Customer Support Agent',
+  defaultSubAgent: routerAgent,
+  subAgents: () => [routerAgent, qaAgent, orderAgent]
+});
+
+await myAgent.init(); // Persist to database
+```
+
+### Tool Builder
+```typescript
+import { tool } from '@inkeep/agents-manage-api';
+
+const searchTool = tool({
+  id: 'search-tool',
+  name: 'Product Search',
+  type: 'mcp',
+  config: {
+    command: 'search-server',
+    args: ['--index', 'products']
+  }
+});
+```
+
+## Database Schema
+
+The API uses SQLite with Drizzle ORM:
+
+### Core Tables
+- `projects` - Multi-tenant project organization
+- `agents` - Agent definitions and instructions
+- `agent_graphs` - Graph collections with default agents
+- `agent_relations` - Transfer/delegation relationships
+- `tools` - MCP tool configurations
+- `tasks` - Execution history and hierarchy
+
+### Key Patterns
+- **Multi-tenancy**: All entities scoped by `tenant_id`
+- **Relationships**: Foreign keys with cascade deletes
+- **Timestamps**: `created_at`/`updated_at` on all entities
+- **JSON Columns**: Complex configurations stored as JSON
+
+## Validation
+
+All API endpoints use Zod schemas for request/response validation:
+
+```typescript
+const createAgentSchema = z.object({
+  id: z.string().min(1),
+  name: z.string().min(1), 
+  instructions: z.string().min(1),
+  tenantId: z.string(),
+  projectId: z.string()
+});
+```
+
+## Integration
+
+### With Agents Run API
+The Agents Manage API provides the configuration that the Agents Run API reads during runtime. Changes to agents, graphs, or tools are immediately available to the execution layer.
+
+### With Agents CLI
+The Agents CLI uses the Agents Manage API for all `push` operations, creating and updating entities from configuration files.
+
+### With Agents Manage UI
+The Agents Manage UI provides a web interface for all Agents Manage API operations, offering visual agent and graph creation.
+
+## Error Handling
+
+- **Validation Errors**: Schema validation with detailed field errors
+- **Constraint Errors**: Database constraint violations with helpful messages
+- **Not Found Errors**: Resource-specific 404 responses
+- **Conflict Errors**: Duplicate key and relationship conflicts
+
+## Security
+
+- **Multi-tenant Isolation**: All queries scoped by tenant ID
+- **Input Validation**: Comprehensive request sanitization
+- **SQL Injection Prevention**: Parameterized queries via Drizzle ORM
+- **Authorization**: Configurable API key authentication
+
+## Performance
+
+- **Database Indexing**: Optimized indexes on frequently queried fields
+- **Connection Pooling**: Efficient database connection management
+- **Caching**: In-memory caching for frequently accessed entities
+- **Parallel Operations**: Concurrent database operations where safe

package/SUPPLEMENTAL_TERMS.md

@@ -0,0 +1,40 @@
+<!--
+AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+Source: ./SUPPLEMENTAL_TERMS.md
+This file is automatically copied from the root SUPPLEMENTAL_TERMS.md during build.
+Any changes should be made to the root SUPPLEMENTAL_TERMS.md file.
+-->
+
+# Inkeep SDK – Elastic License 2.0 with Supplemental Terms
+
+The Inkeep [SDK] (the "Software") is licensed under the Elastic License 2.0 ("ELv2"), available at [https://www.elastic.co/licensing/elastic-license](https://www.elastic.co/licensing/elastic-license), subject to the supplemental terms below. By using the Software, you, your company, and your licensees agree to both ELv2 and these Supplemental Terms – for purposes of these Supplemental Terms, references to "you" have the same meaning as in ELv2 and include your company and contractors acting on your behalf. In the event of conflict, these Supplemental Terms control.
+
+Any copy or redistribution of the Software must include both the ELv2 license reference and these Supplemental Terms.
+
+## 1. Restrictions
+
+### 1.1
+You may not use the Software, directly or indirectly, to offer, enable, operate, or provide any Agent Builder.
+
+### 1.2
+You may not repackage, rebrand, or otherwise expose the Software's agent-creation or orchestration functionality for third-party use, including in specialized or verticalized offerings that present substantially similar functionality to the Software.
+
+### 1.3
+For clarity, the foregoing restrictions do not prohibit your use of the Software as Embedded Assistants or Professional Services, provided neither allow third parties to create, configure, train, orchestrate, deploy, or manage their own agents or agent workflows.
+
+## 2. Definitions
+
+### 2.1 Inkeep
+**"Inkeep"** means Inkeep, Inc., a Delaware corporation with principal offices at 169 Madison Ave, Ste 2544, New York, NY, 10016, the licensor (as defined in ELv2) of the Software.
+
+### 2.2 Agent Builder
+**"Agent Builder"** means any hosted or on-premise product, platform, UI or API that allows third parties (e.g., customers, developers, or community users other than your personnel) to create, configure, compose, train, orchestrate, deploy, or manage their own Agents using the Software, or that otherwise exposes a substantial set of the Agent-creation and orchestration functionality of the Software.
+
+### 2.3 Agents
+**"Agents"** means autonomous, semi-autonomous, or automated systems — including assistants, copilots, workflows, orchestrations, or other systems powered by or incorporating artificial intelligence, machine learning, large language models, or related technologies.
+
+### 2.4 Embedded Assistant
+**"Embedded Assistant"** means embedding the Software in your own products or services to power a specific assistant/copilot/agent experience for you or your end users (e.g., a support bot in your app or an internal helpdesk agent), where end users do not receive access to any substantial set of the Software's agent-creation or orchestration features.
+
+### 2.5 Professional Services
+**"Professional Services"** means using the Software to deliver a bespoke solution to a single client where only your personnel operate the Software, the client receives access solely to the resulting assistant within the client's environment and not to the agent-creation/orchestration features of the Software, and no multi-tenant or self-service builder is provided.