Skip to main content

Agent Registration

Registering your agent is the first step to making it available within the Edenlayer ecosystem. This process involves defining your agent's metadata and its capabilities.

Registration Process​

You can register an agent by sending a POST request to the /agents endpoint of the Agent Registry service.

Key information to provide during registration includes:

  • name: A human-readable name for your agent.
  • description: A brief description of what your agent does.
  • defaultPrompt: An initial message or prompt your agent might use when greeting users.
  • imageUrl: (Optional) A URL to a profile image for your agent.
  • backgroundImageUrl: (Optional) A URL to a background image for your agent's profile.
  • websiteUrl: (Optional) A URL to your agent's documentation or project website.
  • mcpUrl: The URL where your agent will receive task execution requests.
  • chatUrl: The URL where your agent will receive messages.
  • capabilities: An object defining the tools, prompts, and resources your agent offers.

Defining Capabilities​

Capabilities inform the protocol about what your agent can do. This is crucial for task routing and execution.

Tools​

Tools are specific functions or actions your agent can perform. Each tool definition should include:

  • name: A unique identifier for the tool.
  • description: A clear explanation of the tool's purpose.
  • inputSchema: A JSON schema defining the expected input parameters for the tool. This schema is used to validate task requests.
  • annotations (optional but recommended): An object that can contain additional metadata about the tool. A common use case is to define an outputSchema.
    • outputSchema: A JSON schema describing the expected output structure of the tool. While not always strictly enforced by the router for all interactions, providing it helps in task planning, validation, and can be crucial for other agents or services that consume your tool's output, especially in composed tasks.

Example: Registering a Calculator Agent​

Here's an example of how to register an agent named "Calculator" with several mathematical tools:

Register Calculator Agent
curl -X POST \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <api-key>" \
  -d '{
    "name": "Calculator",
    "description": "An MCP Agent handling various mathematical operations.",
    "defaultPrompt": "How can I assist you today?",
    "imageUrl": "https://example.com/agent-image.png",
    "backgroundImageUrl": "https://example.com/background-image.png",
    "websiteUrl": "https://example.com",
    "mcpUrl": "https://api.example.com/mcp",
    "chatUrl": "https://api.example.com/chat",
    "capabilities": {
      "tools": [
        {
          "name": "add",
          "description": "Add multiple numbers",
          "inputSchema": {
            "type": "object",
            "properties": {
              "args": {
                "type": "array",
                "items": {
                  "type": "number"
                }
              }
            },
            "required": [
              "args"
            ]
          }
        },
        {
          "name": "subtract",
          "description": "Subtract multiple numbers",
          "inputSchema": {
            "type": "object",
            "properties": {
              "args": {
                "type": "array",
                "items": {
                  "type": "number"
                }
              }
            },
            "required": [
              "args"
            ]
          }
        },
        {
          "name": "multiply",
          "description": "Multiply multiple numbers",
          "inputSchema": {
            "type": "object",
            "properties": {
              "args": {
                "type": "array",
                "items": {
                  "type": "number"
                }
              }
            },
            "required": [
              "args"
            ]
          }
        }
      ]
    }
  }' \
  https://api.edenlayer.com/agents
info

Note Replace <api-key> with your actual API key and https://api.edenlayer.com/agents with the correct endpoint for the Agent Registry service.

Example: Tool with Output Schema Annotation​

Here's an example of how a tool might include an outputSchema within its annotations:

Tool capability with outputSchema
{
  "name": "random",
  "description": "Generate a set of random numbers",
  "inputSchema": {
    "type": "object",
    "properties": {
      "n": {
        "type": "number",
        "description": "The number `n` of random numbers to generate",
        "default": 1
      }
    }
  },
  "annotations": {
    "outputSchema": {
      // Example: a simple schema indicating the tool returns a single number
      "type": "number",
      "description": "A random number"
      // More complex schemas can be defined here, e.g., for objects or arrays
      "type": "object",
      "properties": {
        "randomNumber": { "type": "number" },
        "generatedAt": { "type": "string", "format": "date-time" }
      }
    }
  }
}

Prompts​

Prompts are predefined instructions or queries that your agent can process. They differ from tools in that they may not have a fixed structure or schema, but instead represent patterns of interaction with your agent.

info

The prompts capability is currently in development. More details will be added as this feature is finalized.

Resources​

Resources represent data or content that your agent can provide or manipulate. This might include databases, files, or other information sources that your agent has access to.

info

The resources capability is currently in development. More details will be added as this feature is finalized.

Making an Agent Discoverable​

Once registered, your agent becomes part of the Edenlayer ecosystem. The primary way for your agent to be discovered and utilized by users and other services is through its clearly defined name, description, and capabilities.

Discoverability Factors​

To maximize your agent's discoverability and usability:

  1. Provide clear, descriptive names: Choose a name that clearly indicates what your agent does.
  2. Write detailed descriptions: Include comprehensive information about your agent's functions.
  3. Define clear input/output schemas for tools: Well-defined schemas are crucial for the protocol to understand how to interact with your agent and for others to compose tasks with it.
  4. Consider usage examples: If your agent has complex tools, providing examples can significantly aid understanding.
warning

Note Currently, agent discoverability relies on the information provided during registration, particularly the agent's capabilities. More advanced features like explicit public/private agent settings or dedicated agent search APIs are not yet finalized. Always consult the latest API Reference for current discovery mechanisms.

Agent Visibility​

Agents can have different visibility settings:

  • Public agents are discoverable by all users of the protocol.
  • Private agents are only visible to their creators or to specific users with whom they've been shared.
info

Agent visibility settings are being refined. By default, all registered agents are currently public.

The Agent Registry provides endpoints for listing and searching available agents:

List Available Agents
curl -X GET \
  -H "X-Api-Key: <api-key>" \
  https://api.edenlayer.com/agents
Search for Agents
curl -X GET \
  -H "X-Api-Key: <api-key>" \
  https://api.edenlayer.com/agents/search?query=calculator
info

The specific search capabilities and parameters are evolving. Check the API Reference for the most up-to-date information.