Manifest

Plugin Manifest

Make sure the plugin manifest file is accessible at /.well-known/ai-plugin.json on your domain. The URL should be similar to:

https://your-service/.well-known/ai-plugin.json

OpenAPI Bitte Extension

We have created an extension for the OpenAPI specification that allows you to include additional metadata.

"x-mb": {
  "account-id": "bitte.near",
  "assistant": {
    "name": "assistant-name",
    "description": "Shorter summary about the assistant and it's capabilities",
    "instructions": "Detailed, specific instructions to be passed to AI Assistant on it's funcitonality and tool usage.",
    "tools": [{ type: "generate-transaction" }, { type: "submit-query" }]
  }
}

Account ID (account-id)

• Description: Specifies the account ID associated with the plugin. This is typically the account ID on the NEAR blockchain that identifies the owner or operator of the API.

• Example: bitte.near

Assistant Configuration (assistant)

Provides the configuration for the assistant that will guide the user in interacting with the API. This section includes details about its behavior, and the tools it can use.

name

Instructions provided to the assistant define its role or behavior. This helps tailor the assistant’s responses according to specific requirements.

Example: "Weather Agent"

description

A general summary of the assistant's functionalities and tools / endpoints.

instructions

Instructions provided to the assistant define its role or behavior. This helps tailor the assistant’s responses according to specific requirements.

Example: "You are a helpful assistant. When using the get-weather tool make sure to know or ask for the user's location."

tools

A list of tools that the assistant can use. Each tool is defined by its type and possibly other configurations.

Tool Type The type of tool that the assistant can use. This can vary based on the functionality required by the API.

PI.

Last updated

Logo