diff --git a/.changeset/slackbot-skills-create.md b/.changeset/slackbot-skills-create.md new file mode 100644 index 000000000..10b4f9647 --- /dev/null +++ b/.changeset/slackbot-skills-create.md @@ -0,0 +1,5 @@ +--- +"@slack/web-api": minor +--- + +feat(web-api): add [`slackbot.skills.create`](https://docs.slack.dev/reference/methods/slackbot.skills.create) method diff --git a/packages/web-api/src/methods.ts b/packages/web-api/src/methods.ts index 640249ff2..73a38ebfe 100644 --- a/packages/web-api/src/methods.ts +++ b/packages/web-api/src/methods.ts @@ -234,6 +234,7 @@ import type { SearchAllArguments, SearchFilesArguments, SearchMessagesArguments, + SlackbotSkillsCreateArguments, SlackListsAccessDeleteArguments, SlackListsAccessSetArguments, SlackListsCreateArguments, @@ -518,6 +519,7 @@ import type { SearchAllResponse, SearchFilesResponse, SearchMessagesResponse, + SlackbotSkillsCreateResponse, SlackListsAccessDeleteResponse, SlackListsAccessSetResponse, SlackListsCreateResponse, @@ -2350,6 +2352,16 @@ export abstract class Methods extends EventEmitter { messages: bindApiCall(this, 'search.messages'), }; + public readonly slackbot = { + skills: { + /** + * @description Creates a skill from markdown instructions, or turns an existing canvas the caller owns into a skill. + * @see {@link https://docs.slack.dev/reference/methods/slackbot.skills.create `slackbot.skills.create` API reference}. + */ + create: bindApiCall(this, 'slackbot.skills.create'), + }, + }; + public readonly slackLists = { access: { /** diff --git a/packages/web-api/src/types/request/index.ts b/packages/web-api/src/types/request/index.ts index f38ebbf54..dc2253690 100644 --- a/packages/web-api/src/types/request/index.ts +++ b/packages/web-api/src/types/request/index.ts @@ -291,6 +291,7 @@ export type { SearchFilesArguments, SearchMessagesArguments, } from './search'; +export type { SlackbotSkillsCreateArguments } from './slackbot'; export type { SlackListsAccessDeleteArguments, SlackListsAccessSetArguments, diff --git a/packages/web-api/src/types/request/slackbot.ts b/packages/web-api/src/types/request/slackbot.ts new file mode 100644 index 000000000..2734bd8e1 --- /dev/null +++ b/packages/web-api/src/types/request/slackbot.ts @@ -0,0 +1,38 @@ +import type { TokenOverridable } from './common'; + +// https://docs.slack.dev/reference/methods/slackbot.skills.create +export interface SlackbotSkillsCreateArguments extends TokenOverridable { + /** @description Human-readable label. Max 255 characters; not unique. */ + display_name: string; + /** @description Markdown body of the skill. Send exactly one of `instructions` or `canvas_id`. */ + instructions?: string; + /** @description Canvas the caller owns to turn into a skill. Send exactly one of `instructions` or `canvas_id`. */ + canvas_id?: string; + /** @description When Slackbot should use the skill. Max 400 characters. */ + description?: string; + /** @description One of the skill categories. */ + category?: + | 'communication' + | 'customer_support' + | 'data_and_analytics' + | 'engineering' + | 'other' + | 'product_management' + | 'productivity' + | 'professional_development' + | 'project_management' + | 'sales' + | 'system' + | 'team_management'; + /** @description Max 200 characters. May contain `{skill}`, which becomes the skill mention. */ + example_prompt?: string; + /** + * @description Apps the skill needs, capped at the caller's MCP server limit. Declaring an app doesn't grant + * access to it. + */ + mcp_servers?: { + service_type: string; + app_id?: string; + server_id?: string; + }[]; +} diff --git a/packages/web-api/src/types/response/SlackbotSkillsCreateResponse.ts b/packages/web-api/src/types/response/SlackbotSkillsCreateResponse.ts new file mode 100644 index 000000000..a905ce5d3 --- /dev/null +++ b/packages/web-api/src/types/response/SlackbotSkillsCreateResponse.ts @@ -0,0 +1,59 @@ +///////////////////////////////////////////////////////////////////////////////////////// +// // +// !!! DO NOT EDIT THIS FILE !!! // +// // +// This file is auto-generated by scripts/generate-web-api-types.sh in the repository. // +// Please refer to the script code to learn how to update the source data. // +// // +///////////////////////////////////////////////////////////////////////////////////////// + +import type { WebAPICallResult } from '../../WebClient'; +export type SlackbotSkillsCreateResponse = WebAPICallResult & { + error?: string; + invalid_mcp_servers?: InvalidmcpServer[]; + needed?: string; + ok?: boolean; + provided?: string; + response_metadata?: ResponseMetadata; + skill?: Skill; + warning?: string; +}; + +export interface InvalidmcpServer { + app_id?: string; + server_id?: string; + service_type?: string; +} + +export interface ResponseMetadata { + messages?: string[]; +} + +export interface Skill { + access?: string; + category?: string; + creator_id?: string; + date_created?: number; + date_updated?: number; + description?: string; + display_name?: string; + example_prompt?: string; + id?: string; + instructions?: string; + is_official?: boolean; + library_count?: number; + mcp_servers?: McpServer[]; + name?: string; + permalink?: string; + type?: string; + usage_count?: number; + visibility?: string; +} + +export interface McpServer { + app_id?: string; + display_name?: string; + is_available?: boolean; + server_id?: string; + service_type?: string; +} diff --git a/packages/web-api/src/types/response/index.ts b/packages/web-api/src/types/response/index.ts index fe0e41999..791c9b66d 100644 --- a/packages/web-api/src/types/response/index.ts +++ b/packages/web-api/src/types/response/index.ts @@ -292,6 +292,7 @@ export { RtmStartResponse } from './RtmStartResponse'; export { SearchAllResponse } from './SearchAllResponse'; export { SearchFilesResponse } from './SearchFilesResponse'; export { SearchMessagesResponse } from './SearchMessagesResponse'; +export { SlackbotSkillsCreateResponse } from './SlackbotSkillsCreateResponse'; export { SlackListsAccessDeleteResponse } from './SlackListsAccessDeleteResponse'; export { SlackListsAccessSetResponse } from './SlackListsAccessSetResponse'; export { SlackListsCreateResponse } from './SlackListsCreateResponse'; diff --git a/packages/web-api/test/types/methods/slackbot.test-d.ts b/packages/web-api/test/types/methods/slackbot.test-d.ts new file mode 100644 index 000000000..b10644bbb --- /dev/null +++ b/packages/web-api/test/types/methods/slackbot.test-d.ts @@ -0,0 +1,63 @@ +import { expectAssignable, expectError } from 'tsd'; +import { WebClient } from '../../../src/WebClient'; + +const web = new WebClient('TOKEN'); + +// slackbot.skills.create +// -- sad path +expectError(web.slackbot.skills.create()); // lacking argument +expectError(web.slackbot.skills.create({})); // empty argument +expectError( + web.slackbot.skills.create({ + instructions: '# Purpose', // missing display_name + }), +); +expectError( + web.slackbot.skills.create({ + display_name: 'Daily priorities', + instructions: '# Purpose', + category: 'cooking', // invalid category + }), +); +expectError( + web.slackbot.skills.create({ + display_name: 'Daily priorities', + instructions: '# Purpose', + mcp_servers: ['A1234'], // mcp_servers are objects + }), +); +expectError( + web.slackbot.skills.create({ + display_name: 'Daily priorities', + instructions: '# Purpose', + mcp_servers: [{ app_id: 'A1234' }], // missing service_type + }), +); +// -- happy path +expectAssignable>([ + { + display_name: 'Daily priorities', // the api requires exactly one of instructions or canvas_id + }, +]); +expectAssignable>([ + { + display_name: 'Daily priorities', + instructions: '# Purpose\nSuggest the three most important things to work on today.', + }, +]); +expectAssignable>([ + { + display_name: 'Daily priorities', + canvas_id: 'F1234', + }, +]); +expectAssignable>([ + { + display_name: 'Daily priorities', + instructions: '# Purpose\nSuggest the three most important things to work on today.', + description: 'Reviews information from Slack and your calendar to suggest priorities for the day.', + category: 'productivity', + example_prompt: 'Run {skill} for today', + mcp_servers: [{ service_type: 'app', app_id: 'A1234', server_id: 'Amcp1234' }], + }, +]);