AgentSchema

Install

Get started with AgentSchema in your preferred language:

Python

pip install agentschema

TypeScript

npm install agentschema

.NET

dotnet add package AgentSchema

Go

go get github.com/microsoft/agentschema-go/agentschema

Quick Example

Python

from agentschema import AgentDefinition

# Load from YAML file
agent = AgentDefinition.from_yaml_file("agent.yaml")

# Or create programmatically
agent = AgentDefinition(
    name="my-assistant",
    description="A helpful AI assistant",
    model="gpt-4o",
    instructions="You are a helpful assistant."
)

# Save to YAML
agent.to_yaml_file("agent.yaml")

TypeScript

import { AgentDefinition } from 'agentschema';
import { readFileSync, writeFileSync } from 'fs';

// Load from YAML file
const yaml = readFileSync('agent.yaml', 'utf-8');
const agent = AgentDefinition.fromYaml(yaml);

// Or create programmatically
const agent = new AgentDefinition({
  name: 'my-assistant',
  description: 'A helpful AI assistant',
  model: 'gpt-4o',
  instructions: 'You are a helpful assistant.'
});

// Save to YAML
writeFileSync('agent.yaml', agent.toYaml());

.NET

using AgentSchema;

// Load from YAML file
var yaml = File.ReadAllText("agent.yaml");
var agent = AgentDefinition.FromYaml(yaml);

// Or create programmatically
var agent = new AgentDefinition
{
    Name = "my-assistant",
    Description = "A helpful AI assistant",
    Model = "gpt-4o",
    Instructions = "You are a helpful assistant."
};

// Save to YAML
File.WriteAllText("agent.yaml", agent.ToYaml());

Go

package main

import (
    "os"
    "github.com/microsoft/agentschema-go/agentschema"
)

func main() {
    // Load from YAML file
    agent, _ := agentschema.LoadAgentDefinitionFromFile("agent.yaml")

    // Or create programmatically
    agent := &agentschema.AgentDefinition{
        Name:         agentschema.String("my-assistant"),
        Description:  agentschema.String("A helpful AI assistant"),
        Model:        "gpt-4o",
        Instructions: agentschema.String("You are a helpful assistant."),
    }

    // Save to YAML
    yaml, _ := agent.ToYAML()
    os.WriteFile("agent.yaml", []byte(yaml), 0644)
}

Why AgentSchema?

Easy to Read & Understand

Simple YAML format that developers can quickly grasp and work with, making agent development accessible to everyone.

Easy Integration

Designed to be easily added to existing repositories without major restructuring or complex setup processes.

Platform Exchange Format

Serves as a unified exchange format between Microsoft Copilot Studio, Microsoft Foundry, and future platforms.

Unified Object Model

Creates a consistent agentic primitive object model that standardizes how agents are defined and structured.

Enterprise-Grade Quality

A joint collaboration between Microsoft Copilot Studio and Microsoft Foundry teams, ensuring production-ready reliability.

Modern Architecture

Built with modern development practices and incorporates advanced agentic features and capabilities.

Getting Started

📖 Object Model

Explore the complete AgentSchema object model with detailed documentation and examples.

View Documentation →

📦 Runtimes

Use our official runtime libraries to work with AgentSchema in TypeScript, Python, C#, or Go.

View Runtimes →

🚀 Examples

See AgentSchema in action with real-world examples including analyst, QnA, and travel agents.

Getting Started Guide →

🤝 Contributing

Help improve the specification by contributing to the AgentSchema project.

Contributing Guide →

⚙️ Code Generation

Generate your own runtime libraries with the TypeSpec emitter.

Emitter Guide →

Key Features

AgentSchema bridges the gap across different agentic platforms, providing a standardized way to define and deploy agents regardless of your chosen environment. It incorporates advanced agentic capabilities while maintaining simplicity and readability, making it the ideal choice for modern agent development workflows.