@inkeep/agents-sdk 0.27.0 → 0.29.0

package/dist/index.cjs

@@ -1517,7 +1517,8 @@ var DataComponent = class {
     this.config = {
       ...config,
       id: this.id,
-      props: processedProps
+      props: processedProps,
+      render: config.render || null
     };
     this.baseURL = process.env.INKEEP_API_URL || "http://localhost:3002";
     this.tenantId = "default";
@@ -1551,6 +1552,9 @@ var DataComponent = class {
   getProps() {
     return this.config.props;
   }
+  getRender() {
+    return this.config.render;
+  }
   // Public method to ensure data component exists in backend (with upsert behavior)
   async init() {
     if (this.initialized) return;
@@ -1580,7 +1584,8 @@ var DataComponent = class {
       id: this.getId(),
       name: this.config.name,
       description: this.config.description,
-      props: this.config.props
+      props: this.config.props,
+      render: this.config.render
     };
     logger6.info({ dataComponentData }, "dataComponentData for create/update");
     const updateResponse = await fetch(
@@ -2258,6 +2263,7 @@ var Project = class {
             if (!credentialReferencesObject[credential2.id]) {
               credentialReferencesObject[credential2.id] = {
                 id: credential2.id,
+                name: credential2.name,
                 type: credential2.type,
                 credentialStoreId: credential2.credentialStoreId,
                 retrievalParams: credential2.retrievalParams
@@ -2375,6 +2381,7 @@ var Project = class {
                     if (!credentialReferencesObject[credential2.id]) {
                       credentialReferencesObject[credential2.id] = {
                         id: credential2.id,
+                        name: credential2.name,
                         type: credential2.type,
                         credentialStoreId: credential2.credentialStoreId,
                         retrievalParams: credential2.retrievalParams
@@ -2399,23 +2406,27 @@ var Project = class {
             let dataComponentName;
             let dataComponentDescription;
             let dataComponentProps;
+            let dataComponentRender;
             if (dataComponent2.getId) {
               dataComponentId = dataComponent2.getId();
               dataComponentName = dataComponent2.getName();
               dataComponentDescription = dataComponent2.getDescription() || "";
               dataComponentProps = dataComponent2.getProps() || {};
+              dataComponentRender = dataComponent2.getRender?.() || null;
             } else {
               dataComponentId = dataComponent2.id || (dataComponent2.name ? dataComponent2.name.toLowerCase().replace(/\s+/g, "-") : "");
               dataComponentName = dataComponent2.name || "";
               dataComponentDescription = dataComponent2.description || "";
               dataComponentProps = dataComponent2.props || {};
+              dataComponentRender = dataComponent2.render || null;
             }
             if (!dataComponentsObject[dataComponentId] && dataComponentName) {
               dataComponentsObject[dataComponentId] = {
                 id: dataComponentId,
                 name: dataComponentName,
                 description: dataComponentDescription,
-                props: dataComponentProps
+                props: dataComponentProps,
+                render: dataComponentRender
               };
             }
           }
@@ -2458,6 +2469,7 @@ var Project = class {
               if (!credentialReferencesObject[credential2.id]) {
                 credentialReferencesObject[credential2.id] = {
                   id: credential2.id,
+                  name: credential2.name,
                   type: credential2.type,
                   credentialStoreId: credential2.credentialStoreId,
                   retrievalParams: credential2.retrievalParams
@@ -2977,7 +2989,8 @@ var SubAgent = class {
           id: comp.getId(),
           name: comp.getName(),
           description: comp.getDescription(),
-          props: comp.getProps()
+          props: comp.getProps(),
+          render: comp.getRender?.() || null
         };
       }
       if (comp && typeof comp === "object" && comp.props && schemaConversion.isZodSchema(comp.props)) {
@@ -2985,7 +2998,8 @@ var SubAgent = class {
           id: comp.id,
           name: comp.name,
           description: comp.description,
-          props: schemaConversion.convertZodToJsonSchemaWithPreview(comp.props)
+          props: schemaConversion.convertZodToJsonSchemaWithPreview(comp.props),
+          render: comp.render || null
         };
       }
       return comp;
@@ -3477,7 +3491,8 @@ var SubAgent = class {
         id: dataComponent2.id,
         name: dataComponent2.name,
         description: dataComponent2.description,
-        props: dataComponent2.props
+        props: dataComponent2.props,
+        render: dataComponent2.render
       });
       dc.setContext(this.tenantId, this.projectId);
       await dc.init();
@@ -3638,7 +3653,15 @@ function subAgent(config) {
   return new SubAgent(config);
 }
 function credential(config) {
-  return agentsCore.CredentialReferenceApiInsertSchema.parse(config);
+  try {
+    return agentsCore.CredentialReferenceApiInsertSchema.parse(config);
+  } catch (error) {
+    if (error instanceof Error) {
+      const credId = config.id || "unknown";
+      throw new Error(`Invalid credential '${credId}': ${error.message}`);
+    }
+    throw error;
+  }
 }
 function mcpServer(config) {
   if (!config.serverUrl) {
@@ -3735,6 +3758,35 @@ function isCredentialReference(value) {
 // src/environment-settings.ts
 function createEnvironmentSettings(environments) {
   return {
+    getEnvironmentCredential: (key) => {
+      const currentEnv = process.env.INKEEP_ENV || "development";
+      const env = environments[currentEnv];
+      if (!env) {
+        throw new Error(
+          `Environment '${currentEnv}' not found. Available: ${Object.keys(environments).join(", ")}`
+        );
+      }
+      const credential2 = env.credentials?.[key];
+      if (!credential2) {
+        throw new Error(`Credential '${String(key)}' not found in environment '${currentEnv}'`);
+      }
+      return credential2;
+    },
+    getEnvironmentMcp: (key) => {
+      const currentEnv = process.env.INKEEP_ENV || "development";
+      const env = environments[currentEnv];
+      if (!env) {
+        throw new Error(
+          `Environment '${currentEnv}' not found. Available: ${Object.keys(environments).join(", ")}`
+        );
+      }
+      const mcpServer2 = env.mcpServers?.[key];
+      if (!mcpServer2) {
+        throw new Error(`MCP Server '${String(key)}' not found in environment '${currentEnv}'`);
+      }
+      return mcpServer2;
+    },
+    //Deprecated: Use getEnvironmentCredential instead
     getEnvironmentSetting: (key) => {
       const currentEnv = process.env.INKEEP_ENV || "development";
       const env = environments[currentEnv];

package/dist/index.d.cts

@@ -156,6 +156,10 @@ interface ArtifactComponentConfig extends ComponentConfig {
 }
 interface DataComponentConfig extends ComponentConfig {
     props: Record<string, unknown> | z.ZodObject<any>;
+    render?: {
+        component: string;
+        mockData: Record<string, unknown>;
+    };
 }
 interface StatusComponentConfig {
     type: string;
@@ -202,8 +206,12 @@ type AgentMcpConfigInput = {
  */
 declare function transfer(targetAgent: SubAgent, description?: string, condition?: TransferConditionFunction): TransferConfig;
 
-type DataComponentConfigWithZod = Omit<DataComponentInsert, 'tenantId' | 'projectId' | 'props'> & {
+type DataComponentConfigWithZod = Omit<DataComponentInsert, 'tenantId' | 'projectId' | 'props' | 'render'> & {
     props?: Record<string, unknown> | z.ZodObject<any> | null;
+    render?: {
+        component: string;
+        mockData: Record<string, unknown>;
+    } | null;
 };
 interface DataComponentInterface {
     config: Omit<DataComponentInsert, 'tenantId' | 'projectId'>;
@@ -227,6 +235,7 @@ declare class DataComponent implements DataComponentInterface {
     getName(): string;
     getDescription(): string;
     getProps(): DataComponentInsert['props'];
+    getRender(): DataComponentInsert['render'];
     init(): Promise<void>;
     private upsertDataComponent;
 }
@@ -1073,12 +1082,14 @@ declare function subAgent(config: SubAgentConfig): SubAgent;
  * ```typescript
  * const apiCredential = credential({
  *   id: 'github-token',
+ *   name: 'GitHub Token',
  *   type: 'bearer',
  *   value: process.env.GITHUB_TOKEN
  * });
  * ```
  */
 declare function credential(config: CredentialReferenceApiInsert): {
+    name: string;
     id: string;
     credentialStoreId: string;
     type: "nango" | "memory" | "keychain";
@@ -1112,6 +1123,7 @@ declare function credential(config: CredentialReferenceApiInsert): {
  *   serverUrl: 'https://secure.example.com/mcp',
  *   credential: credential({
  *     id: 'api-key',
+ *     name: 'API Key',
  *     type: 'bearer',
  *     value: process.env.API_KEY
  *   })
@@ -1313,16 +1325,33 @@ type ExtractCredentialIds<T> = T extends {
 type UnionCredentialIds<T extends Record<string, any>> = {
     [K in keyof T]: ExtractCredentialIds<T[K]>;
 }[keyof T];
+/**
+ * Type helper to extract tool IDs from environment configuration
+ */
+type ExtractMcpServerIds<T> = T extends {
+    mcpServers?: infer T;
+} ? T extends Record<string, any> ? keyof T : never : never;
+/**
+ * Type helper to create a union of all available tool IDs from multiple environments
+ */
+type UnionMcpServerIds<T extends Record<string, any>> = {
+    [K in keyof T]: ExtractMcpServerIds<T[K]>;
+}[keyof T];
 
 interface EnvironmentSettingsConfig {
     credentials?: {
         [settingId: string]: CredentialReferenceApiInsert;
     };
+    mcpServers?: {
+        [mcpServerId: string]: Tool;
+    };
 }
 /**
  * Create a setting helper with TypeScript autocomplete
  */
 declare function createEnvironmentSettings<T extends Record<string, EnvironmentSettingsConfig>>(environments: T): {
+    getEnvironmentCredential: (key: UnionCredentialIds<T>) => CredentialReferenceApiInsert;
+    getEnvironmentMcp: (key: UnionMcpServerIds<T>) => Tool;
     getEnvironmentSetting: (key: UnionCredentialIds<T>) => CredentialReferenceApiInsert;
 };
 /**

package/dist/index.d.ts

@@ -156,6 +156,10 @@ interface ArtifactComponentConfig extends ComponentConfig {
 }
 interface DataComponentConfig extends ComponentConfig {
     props: Record<string, unknown> | z.ZodObject<any>;
+    render?: {
+        component: string;
+        mockData: Record<string, unknown>;
+    };
 }
 interface StatusComponentConfig {
     type: string;
@@ -202,8 +206,12 @@ type AgentMcpConfigInput = {
  */
 declare function transfer(targetAgent: SubAgent, description?: string, condition?: TransferConditionFunction): TransferConfig;
 
-type DataComponentConfigWithZod = Omit<DataComponentInsert, 'tenantId' | 'projectId' | 'props'> & {
+type DataComponentConfigWithZod = Omit<DataComponentInsert, 'tenantId' | 'projectId' | 'props' | 'render'> & {
     props?: Record<string, unknown> | z.ZodObject<any> | null;
+    render?: {
+        component: string;
+        mockData: Record<string, unknown>;
+    } | null;
 };
 interface DataComponentInterface {
     config: Omit<DataComponentInsert, 'tenantId' | 'projectId'>;
@@ -227,6 +235,7 @@ declare class DataComponent implements DataComponentInterface {
     getName(): string;
     getDescription(): string;
     getProps(): DataComponentInsert['props'];
+    getRender(): DataComponentInsert['render'];
     init(): Promise<void>;
     private upsertDataComponent;
 }
@@ -1073,12 +1082,14 @@ declare function subAgent(config: SubAgentConfig): SubAgent;
  * ```typescript
  * const apiCredential = credential({
  *   id: 'github-token',
+ *   name: 'GitHub Token',
  *   type: 'bearer',
  *   value: process.env.GITHUB_TOKEN
  * });
  * ```
  */
 declare function credential(config: CredentialReferenceApiInsert): {
+    name: string;
     id: string;
     credentialStoreId: string;
     type: "nango" | "memory" | "keychain";
@@ -1112,6 +1123,7 @@ declare function credential(config: CredentialReferenceApiInsert): {
  *   serverUrl: 'https://secure.example.com/mcp',
  *   credential: credential({
  *     id: 'api-key',
+ *     name: 'API Key',
  *     type: 'bearer',
  *     value: process.env.API_KEY
  *   })
@@ -1313,16 +1325,33 @@ type ExtractCredentialIds<T> = T extends {
 type UnionCredentialIds<T extends Record<string, any>> = {
     [K in keyof T]: ExtractCredentialIds<T[K]>;
 }[keyof T];
+/**
+ * Type helper to extract tool IDs from environment configuration
+ */
+type ExtractMcpServerIds<T> = T extends {
+    mcpServers?: infer T;
+} ? T extends Record<string, any> ? keyof T : never : never;
+/**
+ * Type helper to create a union of all available tool IDs from multiple environments
+ */
+type UnionMcpServerIds<T extends Record<string, any>> = {
+    [K in keyof T]: ExtractMcpServerIds<T[K]>;
+}[keyof T];
 
 interface EnvironmentSettingsConfig {
     credentials?: {
         [settingId: string]: CredentialReferenceApiInsert;
     };
+    mcpServers?: {
+        [mcpServerId: string]: Tool;
+    };
 }
 /**
  * Create a setting helper with TypeScript autocomplete
  */
 declare function createEnvironmentSettings<T extends Record<string, EnvironmentSettingsConfig>>(environments: T): {
+    getEnvironmentCredential: (key: UnionCredentialIds<T>) => CredentialReferenceApiInsert;
+    getEnvironmentMcp: (key: UnionMcpServerIds<T>) => Tool;
     getEnvironmentSetting: (key: UnionCredentialIds<T>) => CredentialReferenceApiInsert;
 };
 /**

package/dist/index.js

@@ -1490,7 +1490,8 @@ var DataComponent = class {
     this.config = {
       ...config,
       id: this.id,
-      props: processedProps
+      props: processedProps,
+      render: config.render || null
     };
     this.baseURL = process.env.INKEEP_API_URL || "http://localhost:3002";
     this.tenantId = "default";
@@ -1524,6 +1525,9 @@ var DataComponent = class {
   getProps() {
     return this.config.props;
   }
+  getRender() {
+    return this.config.render;
+  }
   // Public method to ensure data component exists in backend (with upsert behavior)
   async init() {
     if (this.initialized) return;
@@ -1553,7 +1557,8 @@ var DataComponent = class {
       id: this.getId(),
       name: this.config.name,
       description: this.config.description,
-      props: this.config.props
+      props: this.config.props,
+      render: this.config.render
     };
     logger6.info({ dataComponentData }, "dataComponentData for create/update");
     const updateResponse = await fetch(
@@ -2231,6 +2236,7 @@ var Project = class {
             if (!credentialReferencesObject[credential2.id]) {
               credentialReferencesObject[credential2.id] = {
                 id: credential2.id,
+                name: credential2.name,
                 type: credential2.type,
                 credentialStoreId: credential2.credentialStoreId,
                 retrievalParams: credential2.retrievalParams
@@ -2348,6 +2354,7 @@ var Project = class {
                     if (!credentialReferencesObject[credential2.id]) {
                       credentialReferencesObject[credential2.id] = {
                         id: credential2.id,
+                        name: credential2.name,
                         type: credential2.type,
                         credentialStoreId: credential2.credentialStoreId,
                         retrievalParams: credential2.retrievalParams
@@ -2372,23 +2379,27 @@ var Project = class {
             let dataComponentName;
             let dataComponentDescription;
             let dataComponentProps;
+            let dataComponentRender;
             if (dataComponent2.getId) {
               dataComponentId = dataComponent2.getId();
               dataComponentName = dataComponent2.getName();
               dataComponentDescription = dataComponent2.getDescription() || "";
               dataComponentProps = dataComponent2.getProps() || {};
+              dataComponentRender = dataComponent2.getRender?.() || null;
             } else {
               dataComponentId = dataComponent2.id || (dataComponent2.name ? dataComponent2.name.toLowerCase().replace(/\s+/g, "-") : "");
               dataComponentName = dataComponent2.name || "";
               dataComponentDescription = dataComponent2.description || "";
               dataComponentProps = dataComponent2.props || {};
+              dataComponentRender = dataComponent2.render || null;
             }
             if (!dataComponentsObject[dataComponentId] && dataComponentName) {
               dataComponentsObject[dataComponentId] = {
                 id: dataComponentId,
                 name: dataComponentName,
                 description: dataComponentDescription,
-                props: dataComponentProps
+                props: dataComponentProps,
+                render: dataComponentRender
               };
             }
           }
@@ -2431,6 +2442,7 @@ var Project = class {
               if (!credentialReferencesObject[credential2.id]) {
                 credentialReferencesObject[credential2.id] = {
                   id: credential2.id,
+                  name: credential2.name,
                   type: credential2.type,
                   credentialStoreId: credential2.credentialStoreId,
                   retrievalParams: credential2.retrievalParams
@@ -2950,7 +2962,8 @@ var SubAgent = class {
           id: comp.getId(),
           name: comp.getName(),
           description: comp.getDescription(),
-          props: comp.getProps()
+          props: comp.getProps(),
+          render: comp.getRender?.() || null
         };
       }
       if (comp && typeof comp === "object" && comp.props && isZodSchema(comp.props)) {
@@ -2958,7 +2971,8 @@ var SubAgent = class {
           id: comp.id,
           name: comp.name,
           description: comp.description,
-          props: convertZodToJsonSchemaWithPreview(comp.props)
+          props: convertZodToJsonSchemaWithPreview(comp.props),
+          render: comp.render || null
         };
       }
       return comp;
@@ -3450,7 +3464,8 @@ var SubAgent = class {
         id: dataComponent2.id,
         name: dataComponent2.name,
         description: dataComponent2.description,
-        props: dataComponent2.props
+        props: dataComponent2.props,
+        render: dataComponent2.render
       });
       dc.setContext(this.tenantId, this.projectId);
       await dc.init();
@@ -3611,7 +3626,15 @@ function subAgent(config) {
   return new SubAgent(config);
 }
 function credential(config) {
-  return CredentialReferenceApiInsertSchema.parse(config);
+  try {
+    return CredentialReferenceApiInsertSchema.parse(config);
+  } catch (error) {
+    if (error instanceof Error) {
+      const credId = config.id || "unknown";
+      throw new Error(`Invalid credential '${credId}': ${error.message}`);
+    }
+    throw error;
+  }
 }
 function mcpServer(config) {
   if (!config.serverUrl) {
@@ -3708,6 +3731,35 @@ function isCredentialReference(value) {
 // src/environment-settings.ts
 function createEnvironmentSettings(environments) {
   return {
+    getEnvironmentCredential: (key) => {
+      const currentEnv = process.env.INKEEP_ENV || "development";
+      const env = environments[currentEnv];
+      if (!env) {
+        throw new Error(
+          `Environment '${currentEnv}' not found. Available: ${Object.keys(environments).join(", ")}`
+        );
+      }
+      const credential2 = env.credentials?.[key];
+      if (!credential2) {
+        throw new Error(`Credential '${String(key)}' not found in environment '${currentEnv}'`);
+      }
+      return credential2;
+    },
+    getEnvironmentMcp: (key) => {
+      const currentEnv = process.env.INKEEP_ENV || "development";
+      const env = environments[currentEnv];
+      if (!env) {
+        throw new Error(
+          `Environment '${currentEnv}' not found. Available: ${Object.keys(environments).join(", ")}`
+        );
+      }
+      const mcpServer2 = env.mcpServers?.[key];
+      if (!mcpServer2) {
+        throw new Error(`MCP Server '${String(key)}' not found in environment '${currentEnv}'`);
+      }
+      return mcpServer2;
+    },
+    //Deprecated: Use getEnvironmentCredential instead
     getEnvironmentSetting: (key) => {
       const currentEnv = process.env.INKEEP_ENV || "development";
       const env = environments[currentEnv];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkeep/agents-sdk",
-  "version": "0.27.0",
+  "version": "0.29.0",
   "description": "Agents SDK for building and managing agents in the Inkeep Agent Framework",
   "main": "dist/index.js",
   "type": "module",
@@ -12,7 +12,7 @@
     "nanoid": "^5.1.5",
     "typescript": "^5.3.3",
     "zod": "^4.1.11",
-    "@inkeep/agents-core": "^0.27.0"
+    "@inkeep/agents-core": "^0.29.0"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",