θΏ™ζ˜―indexlocζδΎ›ηš„ζœεŠ‘οΌŒδΈθ¦θΎ“ε…₯任何密码
Skip to content

Added JSONSchema for plugin.json files #2344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 23, 2024
Merged

Added JSONSchema for plugin.json files #2344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions server/utils/agents/imported-manifest.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "AnythingLLM Agent Skill Plugin Manifest Schema",
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Determines if the custom agent skill is active."
},
"hubId": {
"type": "string",
"description": "Used to identify the custom agent skill. Must be the same as the parent folder name."
},
"name": {
"type": "string",
"description": "The human-readable name of the skill displayed in the AnythingLLM UI."
},
"schema": {
"type": "string",
"enum": [
"skill-1.0.0"
],
"description": "Must be 'skill-1.0.0'. May be updated on manifest spec changes."
},
"version": {
"type": "string",
"description": "Version of the custom agent skill, defined by the user."
},
"description": {
"type": "string",
"description": "Short description of the custom agent skill."
},
"author": {
"type": "string",
"description": "Author tag of the custom agent skill."
},
"author_url": {
"type": "string",
"format": "uri",
"description": "URL of the author of the custom agent skill."
},
"license": {
"type": "string",
"description": "License of the custom agent skill."
},
"setup_args": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of value expected."
},
"required": {
"type": "boolean",
"description": "Indicates if the argument is required."
},
"input": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of input to be rendered."
},
"default": {
"type": "string",
"description": "Default value of the input."
},
"placeholder": {
"type": "string",
"description": "Placeholder text for the input."
},
"hint": {
"type": "string",
"description": "Hint text for the input."
}
},
"required": [
"type"
],
"additionalProperties": false
},
"value": {
"type": "string",
"description": "Preset value of the argument."
}
},
"required": [
"type"
],
"additionalProperties": false
},
"description": "Setup arguments used to configure the custom agent skill from the UI and make runtime arguments accessible in the handler.js file when the skill is called."
},
"examples": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "Example prompt for the custom agent skill."
},
"call": {
"type": "string",
"description": "Expected invocation format matching the input format of the custom agent skill."
}
},
"required": [
"prompt",
"call"
],
"additionalProperties": false
},
"description": "Array of examples used to pre-inject examples into the custom agent skill."
},
"entrypoint": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Location of the file to be executed relative to the plugin.json file."
},
"params": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Short description of the parameter's purpose."
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"boolean"
],
"description": "Type of the parameter."
}
},
"required": [
"description",
"type"
],
"additionalProperties": false
},
"description": "Parameters expected by the custom agent skill."
}
},
"required": [
"file",
"params"
],
"additionalProperties": false,
"description": "Defines the entrypoint of the custom agent skill and the expected inputs."
},
"imported": {
"type": "boolean",
"enum": [
true
],
"description": "Must be set to true."
}
},
"required": [
"active",
"hubId",
"name",
"schema",
"version",
"description",
"entrypoint",
"imported"
],
"additionalProperties": true
}