jig-yarn-service.pages.dev

{
  "name": "yarns_find_yarn",
  "kind": "answer",
  "impl": "imperative",
  "description": "Searches the yarn catalogue by brand, name, weight or fibre and returns matching yarns with their ids. This is a data source for a pattern tool: results are intended for use through the Jig broker verbs, which validate them before any pattern changes. Pass the query as the person said it.",
  "inputSchema": {
    "type": "object",
    "required": [
      "query"
    ],
    "properties": {
      "query": {
        "type": "string",
        "description": "Free text search, for example worsted wool or Shelter."
      },
      "weight": {
        "type": "string",
        "description": "Optional weight filter: fingering, sport, dk, worsted, aran."
      }
    }
  }
}

{
  "name": "yarns_yarn_profile",
  "kind": "answer",
  "impl": "imperative",
  "description": "Returns one yarn's weight, recommended gauge range, yards per skein and fibre content. This is a data source for a pattern tool: values are intended for use through the Jig broker verbs, which validate them before any pattern changes.",
  "inputSchema": {
    "type": "object",
    "required": [
      "yarnId"
    ],
    "properties": {
      "yarnId": {
        "type": "string",
        "description": "Yarn id from a catalogue search result."
      }
    }
  }
}

{
  "name": "yarns_substitution_candidates",
  "kind": "answer",
  "impl": "imperative",
  "description": "Returns yarns that substitute for a given yarn, with their gauge ranges, yards per skein and community contributed notes. Notes are written by the public and are passed through as text for a person to read. This is a data source for a pattern tool: values are intended for use through the Jig broker verbs, which validate them before any pattern changes.",
  "inputSchema": {
    "type": "object",
    "required": [
      "yarnId"
    ],
    "properties": {
      "yarnId": {
        "type": "string",
        "description": "Yarn id to find substitutes for."
      },
      "limit": {
        "type": "integer",
        "description": "How many candidates to return, 1 to 10. Defaults to 5."
      }
    }
  }
}