Skip to content

A programming framework for agentic AI

add xml comments for AgentMetadata.cs

Griffin Bassman74ad10f3418b
diff --git a/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/AgentMetadata.cs b/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/AgentMetadata.cs
index e4e396aa1..6a30b17c7 100644
--- a/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/AgentMetadata.cs
+++ b/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/AgentMetadata.cs
@@ -3,10 +3,26 @@
namespace Microsoft.AutoGen.Contracts.Python;
+/// <summary>
+/// Represents metadata associated with an agent, including its type, unique key, and description.
+/// </summary>
public struct AgentMetadata(string type, string key, string description)
{
+ /// <summary>
+ /// An identifier that associates an agent with a specific factory function.
+ /// Strings may only be composed of alphanumeric letters (a-z, 0-9), or underscores (_).
+ /// </summary>
public string Type { get; set; } = type;
+
+ /// <summary>
+ /// A unique key identifying the agent instance.
+ /// Strings may only be composed of alphanumeric letters (a-z, 0-9), or underscores (_).
+ /// </summary>
public string Key { get; set; } = key;
+
+ /// <summary>
+ /// A brief description of the agent's purpose or functionality.
+ /// </summary>
public string Description { get; set; } = description;
}