agent-swarm-kit 1.0.92 → 1.0.93

package/build/index.cjs

@@ -5,6 +5,8 @@ var diKit = require('di-kit');
 var functoolsKit = require('functools-kit');
 var xml2js = require('xml2js');
 var lodashEs = require('lodash-es');
+var path = require('path');
+var fs = require('fs');
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -172,6 +174,7 @@ var init = (_a$2 = diKit.createActivator("agent-swarm"), _a$2.init), inject = _a
 
 var baseServices$1 = {
     busService: Symbol('busService'),
+    docService: Symbol('docService'),
     loggerService: Symbol('loggerService'),
 };
 var contextServices$1 = {
@@ -1428,6 +1431,7 @@ var CC_LOGGER_ENABLE_DEBUG = false;
 var CC_LOGGER_ENABLE_LOG = true;
 var CC_LOGGER_ENABLE_CONSOLE = false;
 var CC_NAME_TO_TITLE = nameToTitle;
+var CC_FN_PLANTUML = function () { return Promise.resolve(""); };
 var GLOBAL_CONFIG = {
     CC_TOOL_CALL_EXCEPTION_PROMPT: CC_TOOL_CALL_EXCEPTION_PROMPT,
     CC_EMPTY_OUTPUT_PLACEHOLDERS: CC_EMPTY_OUTPUT_PLACEHOLDERS,
@@ -1450,6 +1454,7 @@ var GLOBAL_CONFIG = {
     CC_LOGGER_ENABLE_LOG: CC_LOGGER_ENABLE_LOG,
     CC_LOGGER_ENABLE_CONSOLE: CC_LOGGER_ENABLE_CONSOLE,
     CC_NAME_TO_TITLE: CC_NAME_TO_TITLE,
+    CC_FN_PLANTUML: CC_FN_PLANTUML,
 };
 var setConfig = function (config) {
     Object.assign(GLOBAL_CONFIG, config);
@@ -1803,7 +1808,7 @@ var ClientAgent = /** @class */ (function () {
                             messages: messages,
                             mode: mode,
                             tools: (_a = this.params.tools) === null || _a === void 0 ? void 0 : _a.map(function (t) {
-                                return lodashEs.omit(t, "toolName", "call", "validate", "callbacks");
+                                return lodashEs.omit(t, "toolName", "docNote", "call", "validate", "callbacks");
                             }),
                         };
                         return [4 /*yield*/, this.params.completion.getCompletion(args)];
@@ -4938,6 +4943,11 @@ var AgentValidationService = /** @class */ (function () {
         this.storageValidationService = inject(TYPES.storageValidationService);
         this._agentMap = new Map();
         this._agentDepsMap = new Map();
+        this.getAgentList = function () {
+            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                _this.loggerService.info("agentValidationService getAgentList");
+            return __spreadArray([], __read(_this._agentMap.keys()), false);
+        };
         /**
          * Retrieves the storages used by the agent
          * @param {agentName} agentName - The name of the swarm.
@@ -4945,6 +4955,10 @@ var AgentValidationService = /** @class */ (function () {
          * @throws Will throw an error if the swarm is not found.
          */
         this.getStorageList = function (agentName) {
+            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                _this.loggerService.info("agentValidationService getStorageList", {
+                    agentName: agentName,
+                });
             if (!_this._agentMap.has(agentName)) {
                 throw new Error("agent-swarm agent ".concat(agentName, " not exist (getStorageList)"));
             }
@@ -4957,6 +4971,10 @@ var AgentValidationService = /** @class */ (function () {
          * @throws Will throw an error if the swarm is not found.
          */
         this.getStateList = function (agentName) {
+            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                _this.loggerService.info("agentValidationService getStateList", {
+                    agentName: agentName,
+                });
             if (!_this._agentMap.has(agentName)) {
                 throw new Error("agent-swarm agent ".concat(agentName, " not exist (getStateList)"));
             }
@@ -5492,6 +5510,15 @@ var SwarmValidationService = /** @class */ (function () {
             }
             return swarm.agentList;
         };
+        /**
+         * Retrieves the list of swarms
+         * @returns {string[]} The list of swarm names
+         */
+        this.getSwarmList = function () {
+            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                _this.loggerService.info("swarmValidationService getSwarmList");
+            return __spreadArray([], __read(_this._swarmMap.keys()), false);
+        };
         /**
          * Validates a swarm and its agents.
          * @param {SwarmName} swarmName - The name of the swarm.
@@ -7417,7 +7444,384 @@ var SwarmMetaService = /** @class */ (function () {
     return SwarmMetaService;
 }());
 
+var THREAD_POOL_SIZE = 5;
+var SUBDIR_LIST = ["agent", "image"];
+var DocService = /** @class */ (function () {
+    function DocService() {
+        var _this = this;
+        this.loggerService = inject(TYPES.loggerService);
+        this.swarmValidationService = inject(TYPES.swarmValidationService);
+        this.agentValidationService = inject(TYPES.agentValidationService);
+        this.swarmSchemaService = inject(TYPES.swarmSchemaService);
+        this.agentSchemaService = inject(TYPES.agentSchemaService);
+        this.toolSchemaService = inject(TYPES.toolSchemaService);
+        this.storageSchemaService = inject(TYPES.storageSchemaService);
+        this.stateSchemaService = inject(TYPES.stateSchemaService);
+        this.agentMetaService = inject(TYPES.agentMetaService);
+        this.swarmMetaService = inject(TYPES.swarmMetaService);
+        this.writeSwarmDoc = functoolsKit.execpool(function (swarmSchema, dirName) { return __awaiter(_this, void 0, void 0, function () {
+            var result, umlSchema, umlName, umlSvg, docDescription, i, docDescription, callbackList, i;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                            this.loggerService.info("docService writeSwarmDoc", {
+                                swarmSchema: swarmSchema,
+                            });
+                        result = [];
+                        {
+                            result.push("# ".concat(swarmSchema.swarmName));
+                            if (swarmSchema.docDescription) {
+                                result.push("");
+                                result.push("> ".concat(swarmSchema.docDescription));
+                            }
+                            result.push("");
+                        }
+                        umlSchema = this.swarmMetaService.toUML(swarmSchema.swarmName);
+                        umlName = "swarm_schema_".concat(swarmSchema.swarmName, ".svg");
+                        return [4 /*yield*/, GLOBAL_CONFIG.CC_FN_PLANTUML(umlSchema)];
+                    case 1:
+                        umlSvg = _a.sent();
+                        if (umlSvg) {
+                            fs.writeFileSync(path.join(dirName, "image", umlName), umlSvg);
+                            result.push("![schema](./image/".concat(umlName, ")"));
+                            result.push("");
+                        }
+                        if (swarmSchema.defaultAgent) {
+                            result.push("## Default agent");
+                            result.push("");
+                            result.push(" - [".concat(swarmSchema.defaultAgent, "](./agent/").concat(swarmSchema.defaultAgent, ".md)"));
+                            docDescription = this.agentSchemaService.get(swarmSchema.defaultAgent).docDescription;
+                            if (docDescription) {
+                                result.push("");
+                                result.push(docDescription);
+                            }
+                            result.push("");
+                        }
+                        if (swarmSchema.agentList) {
+                            result.push("## Used agents");
+                            result.push("");
+                            for (i = 0; i !== swarmSchema.agentList.length; i++) {
+                                if (!swarmSchema.agentList[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". [").concat(swarmSchema.agentList[i], "](./agent/").concat(swarmSchema.agentList[i], ".md)"));
+                                docDescription = this.agentSchemaService.get(swarmSchema.agentList[i]).docDescription;
+                                if (docDescription) {
+                                    result.push("");
+                                    result.push(docDescription);
+                                }
+                                result.push("");
+                            }
+                        }
+                        if (swarmSchema.callbacks) {
+                            result.push("## Used callbacks");
+                            result.push("");
+                            callbackList = Object.keys(swarmSchema.callbacks);
+                            for (i = 0; i !== callbackList.length; i++) {
+                                result.push("".concat(i + 1, ". ").concat(callbackList[i]));
+                            }
+                            result.push("");
+                        }
+                        fs.writeFileSync(path.join(dirName, "./".concat(swarmSchema.swarmName, ".md")), result.join("\n"));
+                        return [2 /*return*/];
+                }
+            });
+        }); }, {
+            maxExec: THREAD_POOL_SIZE,
+        });
+        this.writeAgentDoc = functoolsKit.execpool(function (agentSchema, dirName) { return __awaiter(_this, void 0, void 0, function () {
+            var result, umlSchema, umlName, umlSvg, i, i, docDescription, _loop_1, this_1, i, i, _a, docDescription, embedding, shared, callbacks, callbackList, i_1, i, _b, docDescription, shared, callbacks, callbackList, i_2, callbackList, i;
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                            this.loggerService.info("docService writeAgentDoc", {
+                                agentSchema: agentSchema,
+                            });
+                        result = [];
+                        {
+                            result.push("# ".concat(agentSchema.agentName));
+                            if (agentSchema.docDescription) {
+                                result.push("");
+                                result.push("> ".concat(agentSchema.docDescription));
+                            }
+                            result.push("");
+                        }
+                        umlSchema = this.agentMetaService.toUML(agentSchema.agentName);
+                        umlName = "agent_schema_".concat(agentSchema.agentName, ".svg");
+                        return [4 /*yield*/, GLOBAL_CONFIG.CC_FN_PLANTUML(umlSchema)];
+                    case 1:
+                        umlSvg = _d.sent();
+                        if (umlSvg) {
+                            fs.writeFileSync(path.join(dirName, "image", umlName), umlSvg);
+                            result.push("![schema](./image/".concat(umlName, ")"));
+                            result.push("");
+                        }
+                        if (agentSchema.prompt) {
+                            result.push("## Main prompt");
+                            result.push("");
+                            result.push("```");
+                            result.push(agentSchema.prompt);
+                            result.push("```");
+                            result.push("");
+                        }
+                        if (agentSchema.system) {
+                            result.push("## System prompt");
+                            result.push("");
+                            for (i = 0; i !== agentSchema.system.length; i++) {
+                                if (!agentSchema.system[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". `").concat(agentSchema.system[i], "`"));
+                                result.push("");
+                            }
+                        }
+                        if (agentSchema.dependsOn) {
+                            result.push("## Depends on");
+                            result.push("");
+                            for (i = 0; i !== agentSchema.dependsOn.length; i++) {
+                                if (!agentSchema.dependsOn[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". [").concat(agentSchema.dependsOn[i], "](./").concat(agentSchema.dependsOn[i], ".md)"));
+                                docDescription = this.agentSchemaService.get(agentSchema.dependsOn[i]).docDescription;
+                                if (docDescription) {
+                                    result.push("");
+                                    result.push(docDescription);
+                                }
+                                result.push("");
+                            }
+                        }
+                        if (agentSchema.tools) {
+                            result.push("## Used tools");
+                            result.push("");
+                            _loop_1 = function (i) {
+                                if (!agentSchema.tools[i]) {
+                                    return "continue";
+                                }
+                                result.push("> ".concat(i + 1, ". ").concat(agentSchema.tools[i]));
+                                var _e = this_1.toolSchemaService.get(agentSchema.tools[i]), fn = _e.function, docNote = _e.docNote, callbacks = _e.callbacks;
+                                if (fn.name) {
+                                    result.push("");
+                                    result.push("### Name for model");
+                                    result.push("");
+                                    result.push(fn.name);
+                                }
+                                if (fn.description) {
+                                    result.push("");
+                                    result.push("### Description for model");
+                                    result.push("");
+                                    result.push(fn.description);
+                                }
+                                if ((_c = fn.parameters) === null || _c === void 0 ? void 0 : _c.properties) {
+                                    result.push("");
+                                    result.push("### Parameters for model");
+                                    Object.entries(fn.parameters.properties).forEach(function (_a) {
+                                        var _b = __read(_a, 2), key = _b[0], _c = _b[1], type = _c.type, description = _c.description, e = _c.enum;
+                                        result.push("");
+                                        result.push(" - ".concat(key));
+                                        {
+                                            result.push("");
+                                            result.push("**Type:** ".concat(type));
+                                        }
+                                        {
+                                            result.push("");
+                                            result.push("**Description:** ".concat(description));
+                                        }
+                                        if (e) {
+                                            result.push("");
+                                            result.push("**Enum:** ".concat(e.join(", ")));
+                                        }
+                                        {
+                                            result.push("");
+                                            result.push("**Required:** [".concat(fn.parameters.required.includes(key) ? "x" : " ", "]"));
+                                        }
+                                    });
+                                }
+                                if (callbacks) {
+                                    result.push("");
+                                    result.push("### Tool callbacks");
+                                    result.push("");
+                                    var callbackList = Object.keys(callbacks);
+                                    for (var i_3 = 0; i_3 !== callbackList.length; i_3++) {
+                                        result.push(" - ".concat(callbackList[i_3]));
+                                    }
+                                }
+                                if (docNote) {
+                                    result.push("");
+                                    result.push("### Note for developer");
+                                    result.push("");
+                                    result.push(docNote);
+                                }
+                                result.push("");
+                            };
+                            this_1 = this;
+                            for (i = 0; i !== agentSchema.tools.length; i++) {
+                                _loop_1(i);
+                            }
+                        }
+                        if (agentSchema.storages) {
+                            result.push("## Used storages");
+                            result.push("");
+                            for (i = 0; i !== agentSchema.storages.length; i++) {
+                                if (!agentSchema.storages[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". ").concat(agentSchema.storages[i]));
+                                _a = this.storageSchemaService.get(agentSchema.storages[i]), docDescription = _a.docDescription, embedding = _a.embedding, shared = _a.shared, callbacks = _a.callbacks;
+                                if (docDescription) {
+                                    result.push("");
+                                    result.push("### Storage description");
+                                    result.push("");
+                                    result.push(docDescription);
+                                }
+                                if (embedding) {
+                                    result.push("");
+                                    result.push("**Embedding:** ".concat(embedding));
+                                }
+                                {
+                                    result.push("");
+                                    result.push("**Shared:** [".concat(shared ? "x" : " ", "]"));
+                                }
+                                if (callbacks) {
+                                    result.push("");
+                                    result.push("### Storage callbacks");
+                                    result.push("");
+                                    callbackList = Object.keys(callbacks);
+                                    for (i_1 = 0; i_1 !== callbackList.length; i_1++) {
+                                        result.push(" - ".concat(callbackList[i_1]));
+                                    }
+                                }
+                                result.push("");
+                            }
+                        }
+                        if (agentSchema.states) {
+                            result.push("## Used states");
+                            result.push("");
+                            for (i = 0; i !== agentSchema.states.length; i++) {
+                                if (!agentSchema.states[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". ").concat(agentSchema.states[i]));
+                                _b = this.stateSchemaService.get(agentSchema.states[i]), docDescription = _b.docDescription, shared = _b.shared, callbacks = _b.callbacks;
+                                if (docDescription) {
+                                    result.push("");
+                                    result.push("### State description");
+                                    result.push("");
+                                    result.push(docDescription);
+                                }
+                                {
+                                    result.push("");
+                                    result.push("**Shared:** [".concat(shared ? "x" : " ", "]"));
+                                }
+                                if (callbacks) {
+                                    result.push("");
+                                    result.push("### State callbacks");
+                                    result.push("");
+                                    callbackList = Object.keys(callbacks);
+                                    for (i_2 = 0; i_2 !== callbackList.length; i_2++) {
+                                        result.push(" - ".concat(callbackList[i_2]));
+                                    }
+                                }
+                                result.push("");
+                            }
+                        }
+                        if (agentSchema.callbacks) {
+                            result.push("## Used callbacks");
+                            result.push("");
+                            callbackList = Object.keys(agentSchema.callbacks);
+                            for (i = 0; i !== callbackList.length; i++) {
+                                result.push("".concat(i + 1, ". ").concat(callbackList[i]));
+                            }
+                            result.push("");
+                        }
+                        fs.writeFileSync(path.join(dirName, "./agent/".concat(agentSchema.agentName, ".md")), result.join("\n"));
+                        return [2 /*return*/];
+                }
+            });
+        }); }, {
+            maxExec: THREAD_POOL_SIZE,
+        });
+        this.dumpDocs = function () {
+            var args_1 = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args_1[_i] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([], __read(args_1), false), void 0, function (dirName) {
+                var SUBDIR_LIST_1, SUBDIR_LIST_1_1, subDir, path$1;
+                var e_1, _a;
+                var _this = this;
+                if (dirName === void 0) { dirName = path.join(process.cwd(), "docs/chat"); }
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
+                        case 0:
+                            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                                this.loggerService.info("docService dumpDocs", {
+                                    dirName: dirName,
+                                });
+                            try {
+                                for (SUBDIR_LIST_1 = __values(SUBDIR_LIST), SUBDIR_LIST_1_1 = SUBDIR_LIST_1.next(); !SUBDIR_LIST_1_1.done; SUBDIR_LIST_1_1 = SUBDIR_LIST_1.next()) {
+                                    subDir = SUBDIR_LIST_1_1.value;
+                                    path$1 = path.join(dirName, subDir);
+                                    if (!fs.existsSync(path$1)) {
+                                        fs.mkdirSync(path$1, { recursive: true });
+                                    }
+                                }
+                            }
+                            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                            finally {
+                                try {
+                                    if (SUBDIR_LIST_1_1 && !SUBDIR_LIST_1_1.done && (_a = SUBDIR_LIST_1.return)) _a.call(SUBDIR_LIST_1);
+                                }
+                                finally { if (e_1) throw e_1.error; }
+                            }
+                            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                                this.loggerService.info("docService dumpDocs building swarm docs");
+                            return [4 /*yield*/, Promise.all(this.swarmValidationService.getSwarmList().map(function (swarmName) { return __awaiter(_this, void 0, void 0, function () {
+                                    var swarmSchema;
+                                    return __generator(this, function (_a) {
+                                        switch (_a.label) {
+                                            case 0:
+                                                swarmSchema = this.swarmSchemaService.get(swarmName);
+                                                return [4 /*yield*/, this.writeSwarmDoc(swarmSchema, dirName)];
+                                            case 1:
+                                                _a.sent();
+                                                return [2 /*return*/];
+                                        }
+                                    });
+                                }); }))];
+                        case 1:
+                            _b.sent();
+                            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                                this.loggerService.info("docService dumpDocs building agent docs");
+                            return [4 /*yield*/, Promise.all(this.agentValidationService.getAgentList().map(function (agentName) { return __awaiter(_this, void 0, void 0, function () {
+                                    var agentSchema;
+                                    return __generator(this, function (_a) {
+                                        switch (_a.label) {
+                                            case 0:
+                                                agentSchema = this.agentSchemaService.get(agentName);
+                                                return [4 /*yield*/, this.writeAgentDoc(agentSchema, dirName)];
+                                            case 1:
+                                                _a.sent();
+                                                return [2 /*return*/];
+                                        }
+                                    });
+                                }); }))];
+                        case 2:
+                            _b.sent();
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        };
+    }
+    return DocService;
+}());
+
 {
+    provide(TYPES.docService, function () { return new DocService(); });
     provide(TYPES.busService, function () { return new BusService(); });
     provide(TYPES.loggerService, function () { return new LoggerService(); });
 }
@@ -7471,6 +7875,7 @@ var SwarmMetaService = /** @class */ (function () {
 }
 
 var baseServices = {
+    docService: inject(TYPES.docService),
     busService: inject(TYPES.busService),
     loggerService: inject(TYPES.loggerService),
 };
@@ -7520,7 +7925,17 @@ var swarm = __assign(__assign(__assign(__assign(__assign(__assign(__assign({}, b
 init();
 var swarm$1 = swarm;
 
-var METHOD_NAME$E = "function.dumpAgent";
+var METHOD_NAME$F = "cli.dumpDocs";
+var dumpDocs = function (dirName) {
+    if (dirName === void 0) { dirName = "./docs/chat"; }
+    GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+        swarm$1.loggerService.log(METHOD_NAME$F, {
+            dirName: dirName,
+        });
+    return swarm$1.docService.dumpDocs(dirName);
+};
+
+var METHOD_NAME$E = "cli.dumpAgent";
 /**
  * Dumps the agent information into PlantUML format.
  *
@@ -7537,7 +7952,7 @@ var dumpAgent = function (agentName, _a) {
     return swarm$1.agentMetaService.toUML(agentName, withSubtree);
 };
 
-var METHOD_NAME$D = "function.dumpSwarm";
+var METHOD_NAME$D = "cli.dumpSwarm";
 /**
  * Dumps the swarm information into PlantUML format.
  *
@@ -9842,6 +10257,7 @@ exports.commitUserMessageForce = commitUserMessageForce;
 exports.complete = complete;
 exports.disposeConnection = disposeConnection;
 exports.dumpAgent = dumpAgent;
+exports.dumpDocs = dumpDocs;
 exports.dumpSwarm = dumpSwarm;
 exports.emit = emit;
 exports.emitForce = emitForce;

package/build/index.mjs

@@ -3,6 +3,8 @@ import { createActivator } from 'di-kit';
 import { trycatch, singleshot, memoize, ToolRegistry, Subject, queued, getErrorMessage, errorData, not, randomString, createAwaiter, cancelable, CANCELED_PROMISE_SYMBOL, execpool, SortedArray, schedule, ttl, Source, isObject } from 'functools-kit';
 import xml2js from 'xml2js';
 import { omit } from 'lodash-es';
+import { join } from 'path';
+import { writeFileSync, existsSync, mkdirSync } from 'fs';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -170,6 +172,7 @@ var init = (_a$2 = createActivator("agent-swarm"), _a$2.init), inject = _a$2.inj
 
 var baseServices$1 = {
     busService: Symbol('busService'),
+    docService: Symbol('docService'),
     loggerService: Symbol('loggerService'),
 };
 var contextServices$1 = {
@@ -1426,6 +1429,7 @@ var CC_LOGGER_ENABLE_DEBUG = false;
 var CC_LOGGER_ENABLE_LOG = true;
 var CC_LOGGER_ENABLE_CONSOLE = false;
 var CC_NAME_TO_TITLE = nameToTitle;
+var CC_FN_PLANTUML = function () { return Promise.resolve(""); };
 var GLOBAL_CONFIG = {
     CC_TOOL_CALL_EXCEPTION_PROMPT: CC_TOOL_CALL_EXCEPTION_PROMPT,
     CC_EMPTY_OUTPUT_PLACEHOLDERS: CC_EMPTY_OUTPUT_PLACEHOLDERS,
@@ -1448,6 +1452,7 @@ var GLOBAL_CONFIG = {
     CC_LOGGER_ENABLE_LOG: CC_LOGGER_ENABLE_LOG,
     CC_LOGGER_ENABLE_CONSOLE: CC_LOGGER_ENABLE_CONSOLE,
     CC_NAME_TO_TITLE: CC_NAME_TO_TITLE,
+    CC_FN_PLANTUML: CC_FN_PLANTUML,
 };
 var setConfig = function (config) {
     Object.assign(GLOBAL_CONFIG, config);
@@ -1801,7 +1806,7 @@ var ClientAgent = /** @class */ (function () {
                             messages: messages,
                             mode: mode,
                             tools: (_a = this.params.tools) === null || _a === void 0 ? void 0 : _a.map(function (t) {
-                                return omit(t, "toolName", "call", "validate", "callbacks");
+                                return omit(t, "toolName", "docNote", "call", "validate", "callbacks");
                             }),
                         };
                         return [4 /*yield*/, this.params.completion.getCompletion(args)];
@@ -4936,6 +4941,11 @@ var AgentValidationService = /** @class */ (function () {
         this.storageValidationService = inject(TYPES.storageValidationService);
         this._agentMap = new Map();
         this._agentDepsMap = new Map();
+        this.getAgentList = function () {
+            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                _this.loggerService.info("agentValidationService getAgentList");
+            return __spreadArray([], __read(_this._agentMap.keys()), false);
+        };
         /**
          * Retrieves the storages used by the agent
          * @param {agentName} agentName - The name of the swarm.
@@ -4943,6 +4953,10 @@ var AgentValidationService = /** @class */ (function () {
          * @throws Will throw an error if the swarm is not found.
          */
         this.getStorageList = function (agentName) {
+            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                _this.loggerService.info("agentValidationService getStorageList", {
+                    agentName: agentName,
+                });
             if (!_this._agentMap.has(agentName)) {
                 throw new Error("agent-swarm agent ".concat(agentName, " not exist (getStorageList)"));
             }
@@ -4955,6 +4969,10 @@ var AgentValidationService = /** @class */ (function () {
          * @throws Will throw an error if the swarm is not found.
          */
         this.getStateList = function (agentName) {
+            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                _this.loggerService.info("agentValidationService getStateList", {
+                    agentName: agentName,
+                });
             if (!_this._agentMap.has(agentName)) {
                 throw new Error("agent-swarm agent ".concat(agentName, " not exist (getStateList)"));
             }
@@ -5490,6 +5508,15 @@ var SwarmValidationService = /** @class */ (function () {
             }
             return swarm.agentList;
         };
+        /**
+         * Retrieves the list of swarms
+         * @returns {string[]} The list of swarm names
+         */
+        this.getSwarmList = function () {
+            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                _this.loggerService.info("swarmValidationService getSwarmList");
+            return __spreadArray([], __read(_this._swarmMap.keys()), false);
+        };
         /**
          * Validates a swarm and its agents.
          * @param {SwarmName} swarmName - The name of the swarm.
@@ -7415,7 +7442,384 @@ var SwarmMetaService = /** @class */ (function () {
     return SwarmMetaService;
 }());
 
+var THREAD_POOL_SIZE = 5;
+var SUBDIR_LIST = ["agent", "image"];
+var DocService = /** @class */ (function () {
+    function DocService() {
+        var _this = this;
+        this.loggerService = inject(TYPES.loggerService);
+        this.swarmValidationService = inject(TYPES.swarmValidationService);
+        this.agentValidationService = inject(TYPES.agentValidationService);
+        this.swarmSchemaService = inject(TYPES.swarmSchemaService);
+        this.agentSchemaService = inject(TYPES.agentSchemaService);
+        this.toolSchemaService = inject(TYPES.toolSchemaService);
+        this.storageSchemaService = inject(TYPES.storageSchemaService);
+        this.stateSchemaService = inject(TYPES.stateSchemaService);
+        this.agentMetaService = inject(TYPES.agentMetaService);
+        this.swarmMetaService = inject(TYPES.swarmMetaService);
+        this.writeSwarmDoc = execpool(function (swarmSchema, dirName) { return __awaiter(_this, void 0, void 0, function () {
+            var result, umlSchema, umlName, umlSvg, docDescription, i, docDescription, callbackList, i;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                            this.loggerService.info("docService writeSwarmDoc", {
+                                swarmSchema: swarmSchema,
+                            });
+                        result = [];
+                        {
+                            result.push("# ".concat(swarmSchema.swarmName));
+                            if (swarmSchema.docDescription) {
+                                result.push("");
+                                result.push("> ".concat(swarmSchema.docDescription));
+                            }
+                            result.push("");
+                        }
+                        umlSchema = this.swarmMetaService.toUML(swarmSchema.swarmName);
+                        umlName = "swarm_schema_".concat(swarmSchema.swarmName, ".svg");
+                        return [4 /*yield*/, GLOBAL_CONFIG.CC_FN_PLANTUML(umlSchema)];
+                    case 1:
+                        umlSvg = _a.sent();
+                        if (umlSvg) {
+                            writeFileSync(join(dirName, "image", umlName), umlSvg);
+                            result.push("![schema](./image/".concat(umlName, ")"));
+                            result.push("");
+                        }
+                        if (swarmSchema.defaultAgent) {
+                            result.push("## Default agent");
+                            result.push("");
+                            result.push(" - [".concat(swarmSchema.defaultAgent, "](./agent/").concat(swarmSchema.defaultAgent, ".md)"));
+                            docDescription = this.agentSchemaService.get(swarmSchema.defaultAgent).docDescription;
+                            if (docDescription) {
+                                result.push("");
+                                result.push(docDescription);
+                            }
+                            result.push("");
+                        }
+                        if (swarmSchema.agentList) {
+                            result.push("## Used agents");
+                            result.push("");
+                            for (i = 0; i !== swarmSchema.agentList.length; i++) {
+                                if (!swarmSchema.agentList[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". [").concat(swarmSchema.agentList[i], "](./agent/").concat(swarmSchema.agentList[i], ".md)"));
+                                docDescription = this.agentSchemaService.get(swarmSchema.agentList[i]).docDescription;
+                                if (docDescription) {
+                                    result.push("");
+                                    result.push(docDescription);
+                                }
+                                result.push("");
+                            }
+                        }
+                        if (swarmSchema.callbacks) {
+                            result.push("## Used callbacks");
+                            result.push("");
+                            callbackList = Object.keys(swarmSchema.callbacks);
+                            for (i = 0; i !== callbackList.length; i++) {
+                                result.push("".concat(i + 1, ". ").concat(callbackList[i]));
+                            }
+                            result.push("");
+                        }
+                        writeFileSync(join(dirName, "./".concat(swarmSchema.swarmName, ".md")), result.join("\n"));
+                        return [2 /*return*/];
+                }
+            });
+        }); }, {
+            maxExec: THREAD_POOL_SIZE,
+        });
+        this.writeAgentDoc = execpool(function (agentSchema, dirName) { return __awaiter(_this, void 0, void 0, function () {
+            var result, umlSchema, umlName, umlSvg, i, i, docDescription, _loop_1, this_1, i, i, _a, docDescription, embedding, shared, callbacks, callbackList, i_1, i, _b, docDescription, shared, callbacks, callbackList, i_2, callbackList, i;
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                            this.loggerService.info("docService writeAgentDoc", {
+                                agentSchema: agentSchema,
+                            });
+                        result = [];
+                        {
+                            result.push("# ".concat(agentSchema.agentName));
+                            if (agentSchema.docDescription) {
+                                result.push("");
+                                result.push("> ".concat(agentSchema.docDescription));
+                            }
+                            result.push("");
+                        }
+                        umlSchema = this.agentMetaService.toUML(agentSchema.agentName);
+                        umlName = "agent_schema_".concat(agentSchema.agentName, ".svg");
+                        return [4 /*yield*/, GLOBAL_CONFIG.CC_FN_PLANTUML(umlSchema)];
+                    case 1:
+                        umlSvg = _d.sent();
+                        if (umlSvg) {
+                            writeFileSync(join(dirName, "image", umlName), umlSvg);
+                            result.push("![schema](./image/".concat(umlName, ")"));
+                            result.push("");
+                        }
+                        if (agentSchema.prompt) {
+                            result.push("## Main prompt");
+                            result.push("");
+                            result.push("```");
+                            result.push(agentSchema.prompt);
+                            result.push("```");
+                            result.push("");
+                        }
+                        if (agentSchema.system) {
+                            result.push("## System prompt");
+                            result.push("");
+                            for (i = 0; i !== agentSchema.system.length; i++) {
+                                if (!agentSchema.system[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". `").concat(agentSchema.system[i], "`"));
+                                result.push("");
+                            }
+                        }
+                        if (agentSchema.dependsOn) {
+                            result.push("## Depends on");
+                            result.push("");
+                            for (i = 0; i !== agentSchema.dependsOn.length; i++) {
+                                if (!agentSchema.dependsOn[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". [").concat(agentSchema.dependsOn[i], "](./").concat(agentSchema.dependsOn[i], ".md)"));
+                                docDescription = this.agentSchemaService.get(agentSchema.dependsOn[i]).docDescription;
+                                if (docDescription) {
+                                    result.push("");
+                                    result.push(docDescription);
+                                }
+                                result.push("");
+                            }
+                        }
+                        if (agentSchema.tools) {
+                            result.push("## Used tools");
+                            result.push("");
+                            _loop_1 = function (i) {
+                                if (!agentSchema.tools[i]) {
+                                    return "continue";
+                                }
+                                result.push("> ".concat(i + 1, ". ").concat(agentSchema.tools[i]));
+                                var _e = this_1.toolSchemaService.get(agentSchema.tools[i]), fn = _e.function, docNote = _e.docNote, callbacks = _e.callbacks;
+                                if (fn.name) {
+                                    result.push("");
+                                    result.push("### Name for model");
+                                    result.push("");
+                                    result.push(fn.name);
+                                }
+                                if (fn.description) {
+                                    result.push("");
+                                    result.push("### Description for model");
+                                    result.push("");
+                                    result.push(fn.description);
+                                }
+                                if ((_c = fn.parameters) === null || _c === void 0 ? void 0 : _c.properties) {
+                                    result.push("");
+                                    result.push("### Parameters for model");
+                                    Object.entries(fn.parameters.properties).forEach(function (_a) {
+                                        var _b = __read(_a, 2), key = _b[0], _c = _b[1], type = _c.type, description = _c.description, e = _c.enum;
+                                        result.push("");
+                                        result.push(" - ".concat(key));
+                                        {
+                                            result.push("");
+                                            result.push("**Type:** ".concat(type));
+                                        }
+                                        {
+                                            result.push("");
+                                            result.push("**Description:** ".concat(description));
+                                        }
+                                        if (e) {
+                                            result.push("");
+                                            result.push("**Enum:** ".concat(e.join(", ")));
+                                        }
+                                        {
+                                            result.push("");
+                                            result.push("**Required:** [".concat(fn.parameters.required.includes(key) ? "x" : " ", "]"));
+                                        }
+                                    });
+                                }
+                                if (callbacks) {
+                                    result.push("");
+                                    result.push("### Tool callbacks");
+                                    result.push("");
+                                    var callbackList = Object.keys(callbacks);
+                                    for (var i_3 = 0; i_3 !== callbackList.length; i_3++) {
+                                        result.push(" - ".concat(callbackList[i_3]));
+                                    }
+                                }
+                                if (docNote) {
+                                    result.push("");
+                                    result.push("### Note for developer");
+                                    result.push("");
+                                    result.push(docNote);
+                                }
+                                result.push("");
+                            };
+                            this_1 = this;
+                            for (i = 0; i !== agentSchema.tools.length; i++) {
+                                _loop_1(i);
+                            }
+                        }
+                        if (agentSchema.storages) {
+                            result.push("## Used storages");
+                            result.push("");
+                            for (i = 0; i !== agentSchema.storages.length; i++) {
+                                if (!agentSchema.storages[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". ").concat(agentSchema.storages[i]));
+                                _a = this.storageSchemaService.get(agentSchema.storages[i]), docDescription = _a.docDescription, embedding = _a.embedding, shared = _a.shared, callbacks = _a.callbacks;
+                                if (docDescription) {
+                                    result.push("");
+                                    result.push("### Storage description");
+                                    result.push("");
+                                    result.push(docDescription);
+                                }
+                                if (embedding) {
+                                    result.push("");
+                                    result.push("**Embedding:** ".concat(embedding));
+                                }
+                                {
+                                    result.push("");
+                                    result.push("**Shared:** [".concat(shared ? "x" : " ", "]"));
+                                }
+                                if (callbacks) {
+                                    result.push("");
+                                    result.push("### Storage callbacks");
+                                    result.push("");
+                                    callbackList = Object.keys(callbacks);
+                                    for (i_1 = 0; i_1 !== callbackList.length; i_1++) {
+                                        result.push(" - ".concat(callbackList[i_1]));
+                                    }
+                                }
+                                result.push("");
+                            }
+                        }
+                        if (agentSchema.states) {
+                            result.push("## Used states");
+                            result.push("");
+                            for (i = 0; i !== agentSchema.states.length; i++) {
+                                if (!agentSchema.states[i]) {
+                                    continue;
+                                }
+                                result.push("".concat(i + 1, ". ").concat(agentSchema.states[i]));
+                                _b = this.stateSchemaService.get(agentSchema.states[i]), docDescription = _b.docDescription, shared = _b.shared, callbacks = _b.callbacks;
+                                if (docDescription) {
+                                    result.push("");
+                                    result.push("### State description");
+                                    result.push("");
+                                    result.push(docDescription);
+                                }
+                                {
+                                    result.push("");
+                                    result.push("**Shared:** [".concat(shared ? "x" : " ", "]"));
+                                }
+                                if (callbacks) {
+                                    result.push("");
+                                    result.push("### State callbacks");
+                                    result.push("");
+                                    callbackList = Object.keys(callbacks);
+                                    for (i_2 = 0; i_2 !== callbackList.length; i_2++) {
+                                        result.push(" - ".concat(callbackList[i_2]));
+                                    }
+                                }
+                                result.push("");
+                            }
+                        }
+                        if (agentSchema.callbacks) {
+                            result.push("## Used callbacks");
+                            result.push("");
+                            callbackList = Object.keys(agentSchema.callbacks);
+                            for (i = 0; i !== callbackList.length; i++) {
+                                result.push("".concat(i + 1, ". ").concat(callbackList[i]));
+                            }
+                            result.push("");
+                        }
+                        writeFileSync(join(dirName, "./agent/".concat(agentSchema.agentName, ".md")), result.join("\n"));
+                        return [2 /*return*/];
+                }
+            });
+        }); }, {
+            maxExec: THREAD_POOL_SIZE,
+        });
+        this.dumpDocs = function () {
+            var args_1 = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args_1[_i] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([], __read(args_1), false), void 0, function (dirName) {
+                var SUBDIR_LIST_1, SUBDIR_LIST_1_1, subDir, path;
+                var e_1, _a;
+                var _this = this;
+                if (dirName === void 0) { dirName = join(process.cwd(), "docs/chat"); }
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
+                        case 0:
+                            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                                this.loggerService.info("docService dumpDocs", {
+                                    dirName: dirName,
+                                });
+                            try {
+                                for (SUBDIR_LIST_1 = __values(SUBDIR_LIST), SUBDIR_LIST_1_1 = SUBDIR_LIST_1.next(); !SUBDIR_LIST_1_1.done; SUBDIR_LIST_1_1 = SUBDIR_LIST_1.next()) {
+                                    subDir = SUBDIR_LIST_1_1.value;
+                                    path = join(dirName, subDir);
+                                    if (!existsSync(path)) {
+                                        mkdirSync(path, { recursive: true });
+                                    }
+                                }
+                            }
+                            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                            finally {
+                                try {
+                                    if (SUBDIR_LIST_1_1 && !SUBDIR_LIST_1_1.done && (_a = SUBDIR_LIST_1.return)) _a.call(SUBDIR_LIST_1);
+                                }
+                                finally { if (e_1) throw e_1.error; }
+                            }
+                            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                                this.loggerService.info("docService dumpDocs building swarm docs");
+                            return [4 /*yield*/, Promise.all(this.swarmValidationService.getSwarmList().map(function (swarmName) { return __awaiter(_this, void 0, void 0, function () {
+                                    var swarmSchema;
+                                    return __generator(this, function (_a) {
+                                        switch (_a.label) {
+                                            case 0:
+                                                swarmSchema = this.swarmSchemaService.get(swarmName);
+                                                return [4 /*yield*/, this.writeSwarmDoc(swarmSchema, dirName)];
+                                            case 1:
+                                                _a.sent();
+                                                return [2 /*return*/];
+                                        }
+                                    });
+                                }); }))];
+                        case 1:
+                            _b.sent();
+                            GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO &&
+                                this.loggerService.info("docService dumpDocs building agent docs");
+                            return [4 /*yield*/, Promise.all(this.agentValidationService.getAgentList().map(function (agentName) { return __awaiter(_this, void 0, void 0, function () {
+                                    var agentSchema;
+                                    return __generator(this, function (_a) {
+                                        switch (_a.label) {
+                                            case 0:
+                                                agentSchema = this.agentSchemaService.get(agentName);
+                                                return [4 /*yield*/, this.writeAgentDoc(agentSchema, dirName)];
+                                            case 1:
+                                                _a.sent();
+                                                return [2 /*return*/];
+                                        }
+                                    });
+                                }); }))];
+                        case 2:
+                            _b.sent();
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        };
+    }
+    return DocService;
+}());
+
 {
+    provide(TYPES.docService, function () { return new DocService(); });
     provide(TYPES.busService, function () { return new BusService(); });
     provide(TYPES.loggerService, function () { return new LoggerService(); });
 }
@@ -7469,6 +7873,7 @@ var SwarmMetaService = /** @class */ (function () {
 }
 
 var baseServices = {
+    docService: inject(TYPES.docService),
     busService: inject(TYPES.busService),
     loggerService: inject(TYPES.loggerService),
 };
@@ -7518,7 +7923,17 @@ var swarm = __assign(__assign(__assign(__assign(__assign(__assign(__assign({}, b
 init();
 var swarm$1 = swarm;
 
-var METHOD_NAME$E = "function.dumpAgent";
+var METHOD_NAME$F = "cli.dumpDocs";
+var dumpDocs = function (dirName) {
+    if (dirName === void 0) { dirName = "./docs/chat"; }
+    GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+        swarm$1.loggerService.log(METHOD_NAME$F, {
+            dirName: dirName,
+        });
+    return swarm$1.docService.dumpDocs(dirName);
+};
+
+var METHOD_NAME$E = "cli.dumpAgent";
 /**
  * Dumps the agent information into PlantUML format.
  *
@@ -7535,7 +7950,7 @@ var dumpAgent = function (agentName, _a) {
     return swarm$1.agentMetaService.toUML(agentName, withSubtree);
 };
 
-var METHOD_NAME$D = "function.dumpSwarm";
+var METHOD_NAME$D = "cli.dumpSwarm";
 /**
  * Dumps the swarm information into PlantUML format.
  *
@@ -9808,4 +10223,4 @@ var SchemaUtils = /** @class */ (function () {
  */
 var Schema = new SchemaUtils();
 
-export { ExecutionContextService, History, HistoryAdapter, HistoryInstance, Logger, LoggerAdapter, LoggerInstance, MethodContextService, Schema, State, Storage, addAgent, addCompletion, addEmbedding, addState, addStorage, addSwarm, addTool, cancelOutput, cancelOutputForce, changeAgent, commitFlush, commitFlushForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitUserMessage, commitUserMessageForce, complete, disposeConnection, dumpAgent, dumpSwarm, emit, emitForce, event, execute, executeForce, getAgentHistory, getAgentName, getAssistantHistory, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getRawHistory, getSessionMode, getUserHistory, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, session, setConfig, swarm };
+export { ExecutionContextService, History, HistoryAdapter, HistoryInstance, Logger, LoggerAdapter, LoggerInstance, MethodContextService, Schema, State, Storage, addAgent, addCompletion, addEmbedding, addState, addStorage, addSwarm, addTool, cancelOutput, cancelOutputForce, changeAgent, commitFlush, commitFlushForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitUserMessage, commitUserMessageForce, complete, disposeConnection, dumpAgent, dumpDocs, dumpSwarm, emit, emitForce, event, execute, executeForce, getAgentHistory, getAgentName, getAssistantHistory, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getRawHistory, getSessionMode, getUserHistory, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, session, setConfig, swarm };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-swarm-kit",
-  "version": "1.0.92",
+  "version": "1.0.93",
   "description": "A TypeScript library for building orchestrated framework-agnostic multi-agent AI systems",
   "author": {
     "name": "Petr Tripolsky",

package/types.d.ts

@@ -145,6 +145,8 @@ interface IStorageData {
  * @template T - Type of the storage data.
  */
 interface IStorageSchema<T extends IStorageData = IStorageData> {
+    /** The description for documentation */
+    docDescription?: string;
     /**
      * All agents will share the same ClientStorage instance
      */
@@ -340,6 +342,8 @@ interface IStateCallbacks<T extends IStateData = IStateData> {
  * @template T - The type of the state data.
  */
 interface IStateSchema<T extends IStateData = IStateData> {
+    /** The description for documentation */
+    docDescription?: string;
     /**
      * The agents can share the state
      */
@@ -563,6 +567,8 @@ interface ISwarmParams extends Omit<ISwarmSchema, keyof {
  * @interface
  */
 interface ISwarmSchema {
+    /** The description for documentation */
+    docDescription?: string;
     /** Fetch the active agent on init */
     getActiveAgent?: (clientId: string, swarmName: SwarmName, defaultAgent: AgentName) => Promise<AgentName> | AgentName;
     /** Update the active agent after navigation */
@@ -1240,6 +1246,8 @@ interface IAgentToolCallbacks<T = Record<string, unknown>> {
  * @template T - The type of the parameters for the tool.
  */
 interface IAgentTool<T = Record<string, unknown>> extends ITool {
+    /** The description for documentation */
+    docNote?: string;
     /** The name of the tool. */
     toolName: ToolName;
     /**
@@ -1380,6 +1388,8 @@ interface IAgentSchemaCallbacks {
  * Interface representing the schema for an agent.
  */
 interface IAgentSchema {
+    /** The description for documentation */
+    docDescription?: string;
     /** The name of the agent. */
     agentName: AgentName;
     /** The name of the completion. */
@@ -2346,6 +2356,7 @@ declare class AgentValidationService {
     private readonly storageValidationService;
     private _agentMap;
     private _agentDepsMap;
+    getAgentList: () => string[];
     /**
      * Retrieves the storages used by the agent
      * @param {agentName} agentName - The name of the swarm.
@@ -2552,6 +2563,11 @@ declare class SwarmValidationService {
      * @throws Will throw an error if the swarm is not found.
      */
     getAgentList: (swarmName: SwarmName) => string[];
+    /**
+     * Retrieves the list of swarms
+     * @returns {string[]} The list of swarm names
+     */
+    getSwarmList: () => string[];
     /**
      * Validates a swarm and its agents.
      * @param {SwarmName} swarmName - The name of the swarm.
@@ -3091,6 +3107,22 @@ declare class SwarmMetaService {
     toUML: (swarmName: SwarmName) => string;
 }
 
+declare class DocService {
+    private readonly loggerService;
+    private readonly swarmValidationService;
+    private readonly agentValidationService;
+    private readonly swarmSchemaService;
+    private readonly agentSchemaService;
+    private readonly toolSchemaService;
+    private readonly storageSchemaService;
+    private readonly stateSchemaService;
+    private readonly agentMetaService;
+    private readonly swarmMetaService;
+    private writeSwarmDoc;
+    private writeAgentDoc;
+    dumpDocs: (dirName?: string) => Promise<void>;
+}
+
 declare const swarm: {
     agentValidationService: AgentValidationService;
     toolValidationService: ToolValidationService;
@@ -3126,10 +3158,13 @@ declare const swarm: {
     executionContextService: {
         readonly context: IExecutionContext;
     };
+    docService: DocService;
     busService: BusService;
     loggerService: LoggerService;
 };
 
+declare const dumpDocs: (dirName?: string) => Promise<void>;
+
 /**
  * The config for UML generation
  */
@@ -3912,6 +3947,7 @@ declare const GLOBAL_CONFIG: {
     CC_LOGGER_ENABLE_LOG: boolean;
     CC_LOGGER_ENABLE_CONSOLE: boolean;
     CC_NAME_TO_TITLE: (name: string) => string;
+    CC_FN_PLANTUML: (uml: string) => Promise<string>;
 };
 declare const setConfig: (config: Partial<typeof GLOBAL_CONFIG>) => void;
 
@@ -4075,4 +4111,4 @@ declare class SchemaUtils {
  */
 declare const Schema: SchemaUtils;
 
-export { type EventSource, ExecutionContextService, History, HistoryAdapter, HistoryInstance, type IAgentSchema, type IAgentTool, type IBaseEvent, type IBusEvent, type IBusEventContext, type ICompletionArgs, type ICompletionSchema, type ICustomEvent, type IEmbeddingSchema, type IHistoryAdapter, type IHistoryInstance, type IHistoryInstanceCallbacks, type IIncomingMessage, type ILoggerAdapter, type ILoggerInstance, type ILoggerInstanceCallbacks, type IMakeConnectionConfig, type IMakeDisposeParams, type IModelMessage, type IOutgoingMessage, type ISessionConfig, type IStateSchema, type IStorageSchema, type ISwarmSchema, type ITool, type IToolCall, Logger, LoggerAdapter, LoggerInstance, MethodContextService, type ReceiveMessageFn, Schema, type SendMessageFn$1 as SendMessageFn, State, Storage, addAgent, addCompletion, addEmbedding, addState, addStorage, addSwarm, addTool, cancelOutput, cancelOutputForce, changeAgent, commitFlush, commitFlushForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitUserMessage, commitUserMessageForce, complete, disposeConnection, dumpAgent, dumpSwarm, emit, emitForce, event, execute, executeForce, getAgentHistory, getAgentName, getAssistantHistory, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getRawHistory, getSessionMode, getUserHistory, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, session, setConfig, swarm };
+export { type EventSource, ExecutionContextService, History, HistoryAdapter, HistoryInstance, type IAgentSchema, type IAgentTool, type IBaseEvent, type IBusEvent, type IBusEventContext, type ICompletionArgs, type ICompletionSchema, type ICustomEvent, type IEmbeddingSchema, type IHistoryAdapter, type IHistoryInstance, type IHistoryInstanceCallbacks, type IIncomingMessage, type ILoggerAdapter, type ILoggerInstance, type ILoggerInstanceCallbacks, type IMakeConnectionConfig, type IMakeDisposeParams, type IModelMessage, type IOutgoingMessage, type ISessionConfig, type IStateSchema, type IStorageSchema, type ISwarmSchema, type ITool, type IToolCall, Logger, LoggerAdapter, LoggerInstance, MethodContextService, type ReceiveMessageFn, Schema, type SendMessageFn$1 as SendMessageFn, State, Storage, addAgent, addCompletion, addEmbedding, addState, addStorage, addSwarm, addTool, cancelOutput, cancelOutputForce, changeAgent, commitFlush, commitFlushForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitUserMessage, commitUserMessageForce, complete, disposeConnection, dumpAgent, dumpDocs, dumpSwarm, emit, emitForce, event, execute, executeForce, getAgentHistory, getAgentName, getAssistantHistory, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getRawHistory, getSessionMode, getUserHistory, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, session, setConfig, swarm };