Manage skills as sources over ACP (#8675)
Co-authored-by: Lifei Zhou <lifei@squareup.com>
This commit is contained in:
Jack Amadeo
@@ -110,6 +110,36 @@
|
||||
"requestType": "UnarchiveSessionRequest",
|
||||
"responseType": "EmptyResponse"
|
||||
},
|
||||
{
|
||||
"method": "_goose/sources/create",
|
||||
"requestType": "CreateSourceRequest",
|
||||
"responseType": "CreateSourceResponse"
|
||||
},
|
||||
{
|
||||
"method": "_goose/sources/list",
|
||||
"requestType": "ListSourcesRequest",
|
||||
"responseType": "ListSourcesResponse"
|
||||
},
|
||||
{
|
||||
"method": "_goose/sources/update",
|
||||
"requestType": "UpdateSourceRequest",
|
||||
"responseType": "UpdateSourceResponse"
|
||||
},
|
||||
{
|
||||
"method": "_goose/sources/delete",
|
||||
"requestType": "DeleteSourceRequest",
|
||||
"responseType": "EmptyResponse"
|
||||
},
|
||||
{
|
||||
"method": "_goose/sources/export",
|
||||
"requestType": "ExportSourceRequest",
|
||||
"responseType": "ExportSourceResponse"
|
||||
},
|
||||
{
|
||||
"method": "_goose/sources/import",
|
||||
"requestType": "ImportSourcesRequest",
|
||||
"responseType": "ImportSourcesResponse"
|
||||
},
|
||||
{
|
||||
"method": "_goose/dictation/transcribe",
|
||||
"requestType": "DictationTranscribeRequest",
|
||||
|
||||
@@ -795,6 +795,299 @@
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/session/unarchive"
|
||||
},
|
||||
"CreateSourceRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"$ref": "#/$defs/SourceType"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"type": "string"
|
||||
},
|
||||
"content": {
|
||||
"type": "string"
|
||||
},
|
||||
"global": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"projectDir": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "Absolute path to the project root. Required when `global` is false."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"description",
|
||||
"content",
|
||||
"global"
|
||||
],
|
||||
"description": "Create a new source (global or project-scoped).",
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/create"
|
||||
},
|
||||
"SourceType": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"skill"
|
||||
],
|
||||
"description": "The type of source entity."
|
||||
},
|
||||
"CreateSourceResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"source": {
|
||||
"$ref": "#/$defs/SourceEntry"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"source"
|
||||
],
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/create"
|
||||
},
|
||||
"SourceEntry": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"$ref": "#/$defs/SourceType"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"type": "string"
|
||||
},
|
||||
"content": {
|
||||
"type": "string"
|
||||
},
|
||||
"directory": {
|
||||
"type": "string",
|
||||
"description": "Absolute path to the source's directory on disk."
|
||||
},
|
||||
"global": {
|
||||
"type": "boolean",
|
||||
"description": "True when the source lives in the user's global sources directory; false\nwhen it lives inside a specific project."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"description",
|
||||
"content",
|
||||
"directory",
|
||||
"global"
|
||||
],
|
||||
"description": "A source — a user-editable entity backed by an on-disk directory. Sources\nmay be either `global` (shared across all projects) or project-specific."
|
||||
},
|
||||
"ListSourcesRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/$defs/SourceType"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
},
|
||||
"projectDir": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"description": "List sources. If `type` is omitted, sources of all known types are returned.\nBoth global and project-scoped sources are included when `project_dir` is set.",
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/list"
|
||||
},
|
||||
"ListSourcesResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"sources": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/$defs/SourceEntry"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"sources"
|
||||
],
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/list"
|
||||
},
|
||||
"UpdateSourceRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"$ref": "#/$defs/SourceType"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"type": "string"
|
||||
},
|
||||
"content": {
|
||||
"type": "string"
|
||||
},
|
||||
"global": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"projectDir": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"description",
|
||||
"content",
|
||||
"global"
|
||||
],
|
||||
"description": "Update an existing source's description and content.",
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/update"
|
||||
},
|
||||
"UpdateSourceResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"source": {
|
||||
"$ref": "#/$defs/SourceEntry"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"source"
|
||||
],
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/update"
|
||||
},
|
||||
"DeleteSourceRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"$ref": "#/$defs/SourceType"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"global": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"projectDir": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"global"
|
||||
],
|
||||
"description": "Delete a source and its on-disk directory.",
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/delete"
|
||||
},
|
||||
"ExportSourceRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"$ref": "#/$defs/SourceType"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"global": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"projectDir": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"global"
|
||||
],
|
||||
"description": "Export a source as a portable JSON payload.",
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/export"
|
||||
},
|
||||
"ExportSourceResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"json": {
|
||||
"type": "string"
|
||||
},
|
||||
"filename": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"json",
|
||||
"filename"
|
||||
],
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/export"
|
||||
},
|
||||
"ImportSourcesRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "string"
|
||||
},
|
||||
"global": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"projectDir": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"data",
|
||||
"global"
|
||||
],
|
||||
"description": "Import a source from a JSON export payload produced by `_goose/sources/export`.\nThe imported source is written under the given scope; on name collisions a\n`-imported` suffix is appended.",
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/import"
|
||||
},
|
||||
"ImportSourcesResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"sources": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/$defs/SourceEntry"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"sources"
|
||||
],
|
||||
"x-side": "agent",
|
||||
"x-method": "_goose/sources/import"
|
||||
},
|
||||
"DictationTranscribeRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -1328,6 +1621,60 @@
|
||||
"description": "Params for _goose/session/unarchive",
|
||||
"title": "UnarchiveSessionRequest"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/CreateSourceRequest"
|
||||
}
|
||||
],
|
||||
"description": "Params for _goose/sources/create",
|
||||
"title": "CreateSourceRequest"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/ListSourcesRequest"
|
||||
}
|
||||
],
|
||||
"description": "Params for _goose/sources/list",
|
||||
"title": "ListSourcesRequest"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/UpdateSourceRequest"
|
||||
}
|
||||
],
|
||||
"description": "Params for _goose/sources/update",
|
||||
"title": "UpdateSourceRequest"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/DeleteSourceRequest"
|
||||
}
|
||||
],
|
||||
"description": "Params for _goose/sources/delete",
|
||||
"title": "DeleteSourceRequest"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/ExportSourceRequest"
|
||||
}
|
||||
],
|
||||
"description": "Params for _goose/sources/export",
|
||||
"title": "ExportSourceRequest"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/ImportSourcesRequest"
|
||||
}
|
||||
],
|
||||
"description": "Params for _goose/sources/import",
|
||||
"title": "ImportSourcesRequest"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
@@ -1534,6 +1881,46 @@
|
||||
],
|
||||
"title": "ImportSessionResponse"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/CreateSourceResponse"
|
||||
}
|
||||
],
|
||||
"title": "CreateSourceResponse"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/ListSourcesResponse"
|
||||
}
|
||||
],
|
||||
"title": "ListSourcesResponse"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/UpdateSourceResponse"
|
||||
}
|
||||
],
|
||||
"title": "UpdateSourceResponse"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/ExportSourceResponse"
|
||||
}
|
||||
],
|
||||
"title": "ExportSourceResponse"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/$defs/ImportSourcesResponse"
|
||||
}
|
||||
],
|
||||
"title": "ImportSourcesResponse"
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
|
||||
@@ -3115,6 +3115,85 @@ impl GooseAcpAgent {
|
||||
Ok(EmptyResponse {})
|
||||
}
|
||||
|
||||
#[custom_method(CreateSourceRequest)]
|
||||
async fn on_create_source(
|
||||
&self,
|
||||
req: CreateSourceRequest,
|
||||
) -> Result<CreateSourceResponse, sacp::Error> {
|
||||
let source = goose::sources::create_source(
|
||||
req.source_type,
|
||||
&req.name,
|
||||
&req.description,
|
||||
&req.content,
|
||||
req.global,
|
||||
req.project_dir.as_deref(),
|
||||
)?;
|
||||
Ok(CreateSourceResponse { source })
|
||||
}
|
||||
|
||||
#[custom_method(ListSourcesRequest)]
|
||||
async fn on_list_sources(
|
||||
&self,
|
||||
req: ListSourcesRequest,
|
||||
) -> Result<ListSourcesResponse, sacp::Error> {
|
||||
let sources = goose::sources::list_sources(req.source_type, req.project_dir.as_deref())?;
|
||||
Ok(ListSourcesResponse { sources })
|
||||
}
|
||||
|
||||
#[custom_method(UpdateSourceRequest)]
|
||||
async fn on_update_source(
|
||||
&self,
|
||||
req: UpdateSourceRequest,
|
||||
) -> Result<UpdateSourceResponse, sacp::Error> {
|
||||
let source = goose::sources::update_source(
|
||||
req.source_type,
|
||||
&req.name,
|
||||
&req.description,
|
||||
&req.content,
|
||||
req.global,
|
||||
req.project_dir.as_deref(),
|
||||
)?;
|
||||
Ok(UpdateSourceResponse { source })
|
||||
}
|
||||
|
||||
#[custom_method(DeleteSourceRequest)]
|
||||
async fn on_delete_source(
|
||||
&self,
|
||||
req: DeleteSourceRequest,
|
||||
) -> Result<EmptyResponse, sacp::Error> {
|
||||
goose::sources::delete_source(
|
||||
req.source_type,
|
||||
&req.name,
|
||||
req.global,
|
||||
req.project_dir.as_deref(),
|
||||
)?;
|
||||
Ok(EmptyResponse {})
|
||||
}
|
||||
|
||||
#[custom_method(ExportSourceRequest)]
|
||||
async fn on_export_source(
|
||||
&self,
|
||||
req: ExportSourceRequest,
|
||||
) -> Result<ExportSourceResponse, sacp::Error> {
|
||||
let (json, filename) = goose::sources::export_source(
|
||||
req.source_type,
|
||||
&req.name,
|
||||
req.global,
|
||||
req.project_dir.as_deref(),
|
||||
)?;
|
||||
Ok(ExportSourceResponse { json, filename })
|
||||
}
|
||||
|
||||
#[custom_method(ImportSourcesRequest)]
|
||||
async fn on_import_sources(
|
||||
&self,
|
||||
req: ImportSourcesRequest,
|
||||
) -> Result<ImportSourcesResponse, sacp::Error> {
|
||||
let sources =
|
||||
goose::sources::import_sources(&req.data, req.global, req.project_dir.as_deref())?;
|
||||
Ok(ImportSourcesResponse { sources })
|
||||
}
|
||||
|
||||
#[custom_method(DictationTranscribeRequest)]
|
||||
async fn on_dictation_transcribe(
|
||||
&self,
|
||||
|
||||
@@ -296,6 +296,144 @@ pub struct ProviderConfigKey {
|
||||
pub primary: bool,
|
||||
}
|
||||
|
||||
/// The type of source entity.
|
||||
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum SourceType {
|
||||
#[default]
|
||||
Skill,
|
||||
}
|
||||
|
||||
/// A source — a user-editable entity backed by an on-disk directory. Sources
|
||||
/// may be either `global` (shared across all projects) or project-specific.
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct SourceEntry {
|
||||
#[serde(rename = "type")]
|
||||
pub source_type: SourceType,
|
||||
pub name: String,
|
||||
pub description: String,
|
||||
pub content: String,
|
||||
/// Absolute path to the source's directory on disk.
|
||||
pub directory: String,
|
||||
/// True when the source lives in the user's global sources directory; false
|
||||
/// when it lives inside a specific project.
|
||||
pub global: bool,
|
||||
}
|
||||
|
||||
/// Create a new source (global or project-scoped).
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcRequest)]
|
||||
#[request(method = "_goose/sources/create", response = CreateSourceResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct CreateSourceRequest {
|
||||
#[serde(rename = "type")]
|
||||
pub source_type: SourceType,
|
||||
pub name: String,
|
||||
pub description: String,
|
||||
pub content: String,
|
||||
pub global: bool,
|
||||
/// Absolute path to the project root. Required when `global` is false.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub project_dir: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct CreateSourceResponse {
|
||||
pub source: SourceEntry,
|
||||
}
|
||||
|
||||
/// List sources. If `type` is omitted, sources of all known types are returned.
|
||||
/// Both global and project-scoped sources are included when `project_dir` is set.
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcRequest)]
|
||||
#[request(method = "_goose/sources/list", response = ListSourcesResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ListSourcesRequest {
|
||||
#[serde(rename = "type", default, skip_serializing_if = "Option::is_none")]
|
||||
pub source_type: Option<SourceType>,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub project_dir: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ListSourcesResponse {
|
||||
pub sources: Vec<SourceEntry>,
|
||||
}
|
||||
|
||||
/// Update an existing source's description and content.
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcRequest)]
|
||||
#[request(method = "_goose/sources/update", response = UpdateSourceResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct UpdateSourceRequest {
|
||||
#[serde(rename = "type")]
|
||||
pub source_type: SourceType,
|
||||
pub name: String,
|
||||
pub description: String,
|
||||
pub content: String,
|
||||
pub global: bool,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub project_dir: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct UpdateSourceResponse {
|
||||
pub source: SourceEntry,
|
||||
}
|
||||
|
||||
/// Delete a source and its on-disk directory.
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcRequest)]
|
||||
#[request(method = "_goose/sources/delete", response = EmptyResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct DeleteSourceRequest {
|
||||
#[serde(rename = "type")]
|
||||
pub source_type: SourceType,
|
||||
pub name: String,
|
||||
pub global: bool,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub project_dir: Option<String>,
|
||||
}
|
||||
|
||||
/// Export a source as a portable JSON payload.
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcRequest)]
|
||||
#[request(method = "_goose/sources/export", response = ExportSourceResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ExportSourceRequest {
|
||||
#[serde(rename = "type")]
|
||||
pub source_type: SourceType,
|
||||
pub name: String,
|
||||
pub global: bool,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub project_dir: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ExportSourceResponse {
|
||||
pub json: String,
|
||||
pub filename: String,
|
||||
}
|
||||
|
||||
/// Import a source from a JSON export payload produced by `_goose/sources/export`.
|
||||
/// The imported source is written under the given scope; on name collisions a
|
||||
/// `-imported` suffix is appended.
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcRequest)]
|
||||
#[request(method = "_goose/sources/import", response = ImportSourcesResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ImportSourcesRequest {
|
||||
pub data: String,
|
||||
pub global: bool,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub project_dir: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcResponse)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ImportSourcesResponse {
|
||||
pub sources: Vec<SourceEntry>,
|
||||
}
|
||||
|
||||
/// Transcribe audio via a dictation provider.
|
||||
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema, JsonRpcRequest)]
|
||||
#[request(method = "_goose/dictation/transcribe", response = DictationTranscribeResponse)]
|
||||
|
||||
@@ -113,6 +113,7 @@ strum = { workspace = true }
|
||||
once_cell = { workspace = true }
|
||||
etcetera = { workspace = true }
|
||||
fs-err = "3"
|
||||
goose-sdk = { path = "../goose-sdk" }
|
||||
rand = { workspace = true }
|
||||
utoipa = { workspace = true, features = ["chrono"] }
|
||||
tokio-cron-scheduler = "0.14.0"
|
||||
|
||||
@@ -38,6 +38,7 @@ pub mod security;
|
||||
pub mod session;
|
||||
pub mod session_context;
|
||||
pub mod slash_commands;
|
||||
pub mod sources;
|
||||
pub mod subprocess;
|
||||
pub mod token_counter;
|
||||
pub mod tool_inspection;
|
||||
|
||||
@@ -0,0 +1,526 @@
|
||||
//! Filesystem-backed CRUD for [`SourceEntry`] values exchanged over ACP custom
|
||||
//! methods. A source is a user-editable entity stored under a per-scope root
|
||||
//! directory — `~/.agents/skills` for global sources and `<project>/.goose/skills`
|
||||
//! for project-specific sources.
|
||||
|
||||
use crate::agents::platform_extensions::parse_frontmatter;
|
||||
use fs_err as fs;
|
||||
use goose_sdk::custom_requests::{SourceEntry, SourceType};
|
||||
use sacp::Error;
|
||||
use serde::Deserialize;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
#[derive(Deserialize)]
|
||||
struct SkillFront {
|
||||
#[serde(default)]
|
||||
description: String,
|
||||
}
|
||||
|
||||
const GLOBAL_SKILLS_SUBPATH: &[&str] = &[".agents", "skills"];
|
||||
const PROJECT_SKILLS_SUBPATH: &[&str] = &[".goose", "skills"];
|
||||
|
||||
fn home_dir() -> Result<PathBuf, Error> {
|
||||
dirs::home_dir()
|
||||
.ok_or_else(|| Error::internal_error().data("Could not determine home directory"))
|
||||
}
|
||||
|
||||
fn skills_dir_global() -> Result<PathBuf, Error> {
|
||||
let mut dir = home_dir()?;
|
||||
for part in GLOBAL_SKILLS_SUBPATH {
|
||||
dir = dir.join(part);
|
||||
}
|
||||
Ok(dir)
|
||||
}
|
||||
|
||||
fn skills_dir_project(project_dir: &str) -> Result<PathBuf, Error> {
|
||||
if project_dir.trim().is_empty() {
|
||||
return Err(
|
||||
Error::invalid_params().data("projectDir must not be empty when global is false")
|
||||
);
|
||||
}
|
||||
let mut dir = PathBuf::from(project_dir);
|
||||
for part in PROJECT_SKILLS_SUBPATH {
|
||||
dir = dir.join(part);
|
||||
}
|
||||
Ok(dir)
|
||||
}
|
||||
|
||||
fn source_base_dir(
|
||||
source_type: SourceType,
|
||||
global: bool,
|
||||
project_dir: Option<&str>,
|
||||
) -> Result<PathBuf, Error> {
|
||||
match source_type {
|
||||
SourceType::Skill => {
|
||||
if global {
|
||||
skills_dir_global()
|
||||
} else {
|
||||
let pd = project_dir.ok_or_else(|| {
|
||||
Error::invalid_params().data("projectDir is required when global is false")
|
||||
})?;
|
||||
skills_dir_project(pd)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Kebab-case validation: `^[a-z0-9]+(-[a-z0-9]+)*$`. Prevents path traversal
|
||||
/// via names like `../../.ssh/authorized_keys`.
|
||||
fn validate_source_name(name: &str) -> Result<(), Error> {
|
||||
if name.is_empty() {
|
||||
return Err(Error::invalid_params().data("Source name must not be empty"));
|
||||
}
|
||||
let mut expect_alnum = true;
|
||||
for ch in name.chars() {
|
||||
if ch.is_ascii_lowercase() || ch.is_ascii_digit() {
|
||||
expect_alnum = false;
|
||||
} else if ch == '-' && !expect_alnum {
|
||||
expect_alnum = true;
|
||||
} else {
|
||||
return Err(Error::invalid_params().data(format!(
|
||||
"Invalid source name \"{}\". Names must be kebab-case (lowercase letters, digits, and hyphens; \
|
||||
must not start or end with a hyphen or contain consecutive hyphens).",
|
||||
name
|
||||
)));
|
||||
}
|
||||
}
|
||||
if expect_alnum {
|
||||
return Err(Error::invalid_params().data(format!(
|
||||
"Invalid source name \"{}\". Names must not end with a hyphen.",
|
||||
name
|
||||
)));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn build_skill_md(name: &str, description: &str, content: &str) -> String {
|
||||
// YAML single-quoted strings escape a literal single quote by doubling it.
|
||||
let safe_desc = description.replace('\'', "''");
|
||||
let mut md = format!("---\nname: {}\ndescription: '{}'\n---\n", name, safe_desc);
|
||||
if !content.is_empty() {
|
||||
md.push('\n');
|
||||
md.push_str(content);
|
||||
md.push('\n');
|
||||
}
|
||||
md
|
||||
}
|
||||
|
||||
fn parse_skill_frontmatter(raw: &str) -> (String, String) {
|
||||
if !raw.trim_start().starts_with("---") {
|
||||
return (String::new(), raw.to_string());
|
||||
}
|
||||
match parse_frontmatter::<SkillFront>(raw) {
|
||||
Ok(Some((meta, body))) => (meta.description, body),
|
||||
_ => (String::new(), raw.to_string()),
|
||||
}
|
||||
}
|
||||
|
||||
fn source_entry(
|
||||
source_type: SourceType,
|
||||
name: &str,
|
||||
description: &str,
|
||||
content: &str,
|
||||
dir: &Path,
|
||||
global: bool,
|
||||
) -> SourceEntry {
|
||||
SourceEntry {
|
||||
source_type,
|
||||
name: name.to_string(),
|
||||
description: description.to_string(),
|
||||
content: content.to_string(),
|
||||
directory: dir.to_string_lossy().to_string(),
|
||||
global,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn create_source(
|
||||
source_type: SourceType,
|
||||
name: &str,
|
||||
description: &str,
|
||||
content: &str,
|
||||
global: bool,
|
||||
project_dir: Option<&str>,
|
||||
) -> Result<SourceEntry, Error> {
|
||||
validate_source_name(name)?;
|
||||
let dir = source_base_dir(source_type, global, project_dir)?.join(name);
|
||||
|
||||
if dir.exists() {
|
||||
return Err(
|
||||
Error::invalid_params().data(format!("A source named \"{}\" already exists", name))
|
||||
);
|
||||
}
|
||||
|
||||
fs::create_dir_all(&dir).map_err(|e| {
|
||||
Error::internal_error().data(format!("Failed to create source directory: {e}"))
|
||||
})?;
|
||||
let file_path = dir.join("SKILL.md");
|
||||
let md = build_skill_md(name, description, content);
|
||||
fs::write(&file_path, md)
|
||||
.map_err(|e| Error::internal_error().data(format!("Failed to write SKILL.md: {e}")))?;
|
||||
|
||||
Ok(source_entry(
|
||||
source_type,
|
||||
name,
|
||||
description,
|
||||
content,
|
||||
&dir,
|
||||
global,
|
||||
))
|
||||
}
|
||||
|
||||
pub fn update_source(
|
||||
source_type: SourceType,
|
||||
name: &str,
|
||||
description: &str,
|
||||
content: &str,
|
||||
global: bool,
|
||||
project_dir: Option<&str>,
|
||||
) -> Result<SourceEntry, Error> {
|
||||
validate_source_name(name)?;
|
||||
let dir = source_base_dir(source_type, global, project_dir)?.join(name);
|
||||
|
||||
if !dir.exists() {
|
||||
return Err(Error::invalid_params().data(format!("Source \"{}\" not found", name)));
|
||||
}
|
||||
|
||||
let file_path = dir.join("SKILL.md");
|
||||
let md = build_skill_md(name, description, content);
|
||||
fs::write(&file_path, md)
|
||||
.map_err(|e| Error::internal_error().data(format!("Failed to write SKILL.md: {e}")))?;
|
||||
|
||||
Ok(source_entry(
|
||||
source_type,
|
||||
name,
|
||||
description,
|
||||
content,
|
||||
&dir,
|
||||
global,
|
||||
))
|
||||
}
|
||||
|
||||
pub fn delete_source(
|
||||
source_type: SourceType,
|
||||
name: &str,
|
||||
global: bool,
|
||||
project_dir: Option<&str>,
|
||||
) -> Result<(), Error> {
|
||||
validate_source_name(name)?;
|
||||
let dir = source_base_dir(source_type, global, project_dir)?.join(name);
|
||||
|
||||
if !dir.exists() {
|
||||
return Err(Error::invalid_params().data(format!("Source \"{}\" not found", name)));
|
||||
}
|
||||
fs::remove_dir_all(&dir)
|
||||
.map_err(|e| Error::internal_error().data(format!("Failed to delete source: {e}")))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn list_sources(
|
||||
source_type: Option<SourceType>,
|
||||
project_dir: Option<&str>,
|
||||
) -> Result<Vec<SourceEntry>, Error> {
|
||||
let kinds: Vec<SourceType> = match source_type {
|
||||
Some(k) => vec![k],
|
||||
None => vec![SourceType::Skill],
|
||||
};
|
||||
|
||||
let mut sources = Vec::new();
|
||||
for kind in kinds {
|
||||
match kind {
|
||||
SourceType::Skill => {
|
||||
if let Some(pd) = project_dir {
|
||||
if !pd.trim().is_empty() {
|
||||
let dir = skills_dir_project(pd)?;
|
||||
sources.extend(read_skill_dir(&dir, false)?);
|
||||
}
|
||||
}
|
||||
let dir = skills_dir_global()?;
|
||||
sources.extend(read_skill_dir(&dir, true)?);
|
||||
}
|
||||
}
|
||||
}
|
||||
sources.sort_by(|a, b| a.name.cmp(&b.name));
|
||||
Ok(sources)
|
||||
}
|
||||
|
||||
fn read_skill_dir(dir: &Path, global: bool) -> Result<Vec<SourceEntry>, Error> {
|
||||
if !dir.exists() {
|
||||
return Ok(Vec::new());
|
||||
}
|
||||
let entries = fs::read_dir(dir)
|
||||
.map_err(|e| Error::internal_error().data(format!("Failed to read skills dir: {e}")))?;
|
||||
|
||||
let mut out = Vec::new();
|
||||
for entry in entries.flatten() {
|
||||
let path = entry.path();
|
||||
if !path.is_dir() {
|
||||
continue;
|
||||
}
|
||||
let skill_md = path.join("SKILL.md");
|
||||
if !skill_md.exists() {
|
||||
continue;
|
||||
}
|
||||
let name = path
|
||||
.file_name()
|
||||
.and_then(|n| n.to_str())
|
||||
.unwrap_or("")
|
||||
.to_string();
|
||||
let raw = fs::read_to_string(&skill_md).unwrap_or_default();
|
||||
let (description, content) = parse_skill_frontmatter(&raw);
|
||||
out.push(source_entry(
|
||||
SourceType::Skill,
|
||||
&name,
|
||||
&description,
|
||||
&content,
|
||||
&path,
|
||||
global,
|
||||
));
|
||||
}
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
pub fn export_source(
|
||||
source_type: SourceType,
|
||||
name: &str,
|
||||
global: bool,
|
||||
project_dir: Option<&str>,
|
||||
) -> Result<(String, String), Error> {
|
||||
validate_source_name(name)?;
|
||||
let dir = source_base_dir(source_type, global, project_dir)?.join(name);
|
||||
|
||||
if !dir.exists() {
|
||||
return Err(Error::invalid_params().data(format!("Source \"{}\" not found", name)));
|
||||
}
|
||||
|
||||
let md = dir.join("SKILL.md");
|
||||
let raw = fs::read_to_string(&md)
|
||||
.map_err(|e| Error::internal_error().data(format!("Failed to read SKILL.md: {e}")))?;
|
||||
let (description, content) = parse_skill_frontmatter(&raw);
|
||||
|
||||
let type_slug = match source_type {
|
||||
SourceType::Skill => "skill",
|
||||
};
|
||||
let export = serde_json::json!({
|
||||
"version": 1,
|
||||
"type": type_slug,
|
||||
"name": name,
|
||||
"description": description,
|
||||
"content": content,
|
||||
});
|
||||
let json = serde_json::to_string_pretty(&export)
|
||||
.map_err(|e| Error::internal_error().data(format!("Failed to serialize source: {e}")))?;
|
||||
let filename = format!("{}.{}.json", name, type_slug);
|
||||
Ok((json, filename))
|
||||
}
|
||||
|
||||
pub fn import_sources(
|
||||
data: &str,
|
||||
global: bool,
|
||||
project_dir: Option<&str>,
|
||||
) -> Result<Vec<SourceEntry>, Error> {
|
||||
let value: serde_json::Value = serde_json::from_str(data)
|
||||
.map_err(|e| Error::invalid_params().data(format!("Invalid JSON: {e}")))?;
|
||||
|
||||
let version = value
|
||||
.get("version")
|
||||
.and_then(|v| v.as_u64())
|
||||
.ok_or_else(|| Error::invalid_params().data("Missing or invalid \"version\" field"))?;
|
||||
if version != 1 {
|
||||
return Err(
|
||||
Error::invalid_params().data(format!("Unsupported source export version: {}", version))
|
||||
);
|
||||
}
|
||||
|
||||
// Default to `skill` to preserve compatibility with pre-sources skill exports.
|
||||
let source_type = match value
|
||||
.get("type")
|
||||
.and_then(|v| v.as_str())
|
||||
.unwrap_or("skill")
|
||||
{
|
||||
"skill" => SourceType::Skill,
|
||||
other => {
|
||||
return Err(Error::invalid_params().data(format!("Unsupported source type: {}", other)));
|
||||
}
|
||||
};
|
||||
|
||||
let name = value
|
||||
.get("name")
|
||||
.and_then(|v| v.as_str())
|
||||
.ok_or_else(|| Error::invalid_params().data("Missing or invalid \"name\" field"))?
|
||||
.to_string();
|
||||
if name.is_empty() {
|
||||
return Err(Error::invalid_params().data("Source name must not be empty"));
|
||||
}
|
||||
|
||||
let description = value
|
||||
.get("description")
|
||||
.and_then(|v| v.as_str())
|
||||
.ok_or_else(|| Error::invalid_params().data("Missing or invalid \"description\" field"))?
|
||||
.to_string();
|
||||
if description.is_empty() {
|
||||
return Err(Error::invalid_params().data("Source description must not be empty"));
|
||||
}
|
||||
|
||||
// Accept both the new `content` key and the legacy skills `instructions` key.
|
||||
let content = value
|
||||
.get("content")
|
||||
.or_else(|| value.get("instructions"))
|
||||
.and_then(|v| v.as_str())
|
||||
.unwrap_or("")
|
||||
.to_string();
|
||||
|
||||
validate_source_name(&name)?;
|
||||
|
||||
let base = source_base_dir(source_type, global, project_dir)?;
|
||||
let mut final_name = name.clone();
|
||||
if base.join(&final_name).exists() {
|
||||
final_name = format!("{}-imported", name);
|
||||
let mut counter = 2u32;
|
||||
while base.join(&final_name).exists() {
|
||||
final_name = format!("{}-imported-{}", name, counter);
|
||||
counter += 1;
|
||||
}
|
||||
}
|
||||
|
||||
let dir = base.join(&final_name);
|
||||
fs::create_dir_all(&dir).map_err(|e| {
|
||||
Error::internal_error().data(format!("Failed to create source directory: {e}"))
|
||||
})?;
|
||||
let file_path = dir.join("SKILL.md");
|
||||
let md = build_skill_md(&final_name, &description, &content);
|
||||
fs::write(&file_path, md)
|
||||
.map_err(|e| Error::internal_error().data(format!("Failed to write SKILL.md: {e}")))?;
|
||||
|
||||
Ok(vec![source_entry(
|
||||
source_type,
|
||||
&final_name,
|
||||
&description,
|
||||
&content,
|
||||
&dir,
|
||||
global,
|
||||
)])
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use tempfile::TempDir;
|
||||
|
||||
#[test]
|
||||
fn kebab_case_validation() {
|
||||
assert!(validate_source_name("my-skill").is_ok());
|
||||
assert!(validate_source_name("abc123").is_ok());
|
||||
assert!(validate_source_name("").is_err());
|
||||
assert!(validate_source_name("-leading").is_err());
|
||||
assert!(validate_source_name("trailing-").is_err());
|
||||
assert!(validate_source_name("double--hyphen").is_err());
|
||||
assert!(validate_source_name("CAPS").is_err());
|
||||
assert!(validate_source_name("../escape").is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn create_list_update_delete_project_skill() {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let project = tmp.path().to_str().unwrap();
|
||||
|
||||
let created = create_source(
|
||||
SourceType::Skill,
|
||||
"my-skill",
|
||||
"does the thing",
|
||||
"step one\nstep two",
|
||||
false,
|
||||
Some(project),
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(created.name, "my-skill");
|
||||
assert!(!created.global);
|
||||
assert!(PathBuf::from(&created.directory).join("SKILL.md").exists());
|
||||
|
||||
let listed = list_sources(Some(SourceType::Skill), Some(project)).unwrap();
|
||||
assert!(listed.iter().any(|s| s.name == "my-skill" && !s.global));
|
||||
|
||||
let updated = update_source(
|
||||
SourceType::Skill,
|
||||
"my-skill",
|
||||
"now does a different thing",
|
||||
"step three",
|
||||
false,
|
||||
Some(project),
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(updated.description, "now does a different thing");
|
||||
|
||||
delete_source(SourceType::Skill, "my-skill", false, Some(project)).unwrap();
|
||||
assert!(!PathBuf::from(&created.directory).exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn create_rejects_duplicate_name() {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let project = tmp.path().to_str().unwrap();
|
||||
|
||||
create_source(SourceType::Skill, "dup", "d", "c", false, Some(project)).unwrap();
|
||||
let err =
|
||||
create_source(SourceType::Skill, "dup", "d", "c", false, Some(project)).unwrap_err();
|
||||
assert!(format!("{:?}", err).contains("already exists"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn project_scope_requires_project_dir() {
|
||||
let err = create_source(SourceType::Skill, "x", "d", "c", false, None).unwrap_err();
|
||||
assert!(format!("{:?}", err).contains("projectDir"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn export_then_import_roundtrip() {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let project_a = tmp.path().join("a");
|
||||
let project_b = tmp.path().join("b");
|
||||
std::fs::create_dir_all(&project_a).unwrap();
|
||||
std::fs::create_dir_all(&project_b).unwrap();
|
||||
|
||||
create_source(
|
||||
SourceType::Skill,
|
||||
"portable",
|
||||
"describes itself",
|
||||
"body goes here",
|
||||
false,
|
||||
Some(project_a.to_str().unwrap()),
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
let (json, filename) = export_source(
|
||||
SourceType::Skill,
|
||||
"portable",
|
||||
false,
|
||||
Some(project_a.to_str().unwrap()),
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(filename, "portable.skill.json");
|
||||
|
||||
let imported = import_sources(&json, false, Some(project_b.to_str().unwrap())).unwrap();
|
||||
assert_eq!(imported.len(), 1);
|
||||
assert_eq!(imported[0].name, "portable");
|
||||
assert_eq!(imported[0].description, "describes itself");
|
||||
assert_eq!(imported[0].content, "body goes here");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn import_collision_appends_suffix() {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let project = tmp.path().to_str().unwrap();
|
||||
|
||||
create_source(SourceType::Skill, "busy", "d", "c", false, Some(project)).unwrap();
|
||||
|
||||
let payload = serde_json::json!({
|
||||
"version": 1,
|
||||
"type": "skill",
|
||||
"name": "busy",
|
||||
"description": "d",
|
||||
"content": "c",
|
||||
})
|
||||
.to_string();
|
||||
let imported = import_sources(&payload, false, Some(project)).unwrap();
|
||||
assert_eq!(imported[0].name, "busy-imported");
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user