Record Class SkillProviderDescriptor

java.lang.Object
java.lang.Record
com.github.copilot.SkillProviderDescriptor
Record Components:
name - the invocation and display name
description - the description shown in skill catalogs
userInvocable - whether users may invoke the skill directly, or null for the default (true)
disableModelInvocation - whether model invocation is disabled, or null for the default (false)
argumentHint - an optional freeform argument hint for slash-command catalogs
directory - the absolute path to the folder on local disk that holds the skill's supporting files (scripts, references, templates, assets), or null when the skill has none. When the skill is activated, the runtime lists the folder's files for the model, as it does for a file-based skill's folder; it never reads or copies them. The folder becomes a read-only skill root, like a configured skill directory. It is not shown in skill catalogs.
@CopilotExperimental public record SkillProviderDescriptor(String name, String description, Boolean userInvocable, Boolean disableModelInvocation, String argumentHint, String directory) extends Record
Catalog metadata for one skill supplied by a SkillProvider.

The runtime lists these descriptors without fetching skill content, then calls SkillProvider.readSkill(String) when the skill is used.

Since:
1.0.0

  • Constructor Details

    • SkillProviderDescriptor

      public SkillProviderDescriptor(String name, String description, Boolean userInvocable, Boolean disableModelInvocation, String argumentHint)
      Creates a descriptor for a skill without supporting files.
      Parameters:
      name - the invocation and display name
      description - the description shown in skill catalogs
      userInvocable - whether users may invoke the skill directly, or null for the default (true)
      disableModelInvocation - whether model invocation is disabled, or null for the default (false)
      argumentHint - an optional freeform argument hint for slash-command catalogs

    • SkillProviderDescriptor

      public SkillProviderDescriptor(String name, String description, Boolean userInvocable, Boolean disableModelInvocation, String argumentHint, String directory)
      Creates an instance of a SkillProviderDescriptor record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      userInvocable - the value for the userInvocable record component
      disableModelInvocation - the value for the disableModelInvocation record component
      argumentHint - the value for the argumentHint record component
      directory - the value for the directory record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • userInvocable

      public Boolean userInvocable()
      Returns the value of the userInvocable record component.
      Returns:
      the value of the userInvocable record component

    • disableModelInvocation

      public Boolean disableModelInvocation()
      Returns the value of the disableModelInvocation record component.
      Returns:
      the value of the disableModelInvocation record component

    • argumentHint

      public String argumentHint()
      Returns the value of the argumentHint record component.
      Returns:
      the value of the argumentHint record component

    • directory

      public String directory()
      Returns the value of the directory record component.
      Returns:
      the value of the directory record component