{"openapi":"3.1.0","info":{"title":"Youtrack Projects and Boards (BYOK) API","version":"0.1.0","description":"Youtrack Projects and Boards (BYOK) lets an AI assistant read your own Youtrack Projects and Boards data through the Youtrack Projects and Boards API with a key you supply (YouTrack permanent token). Read-only: 7 tools (list_projects, list_project_custom_fields, list_agile_boards, list_sprints, list_saved_queries, list_tags, list_issue_link_types). The BYOK key travels with each request, is used...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-youtrack-projects.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-youtrack-projects/docs"},"termsOfService":"https://connectorbay.com/byok-youtrack-projects/terms"},"servers":[{"url":"https://byok-youtrack-projects.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-youtrack-projects/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_projects":{"post":{"operationId":"list_projects","summary":"List projects with id, name, short name, description, archived flag and leader. Needs permission to read project setting","description":"List projects with id, name, short name, description, archived flag and leader. Needs permission to read project settings. Use for \"What projects exist in YouTrack\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your YouTrack Cloud name: the part before .youtrack.cloud, for example 'mycompany' for mycompany.youtrack.cloud.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"top":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":42,"description":"How many items to return (1 to 100, default 42).","title":"Top"},"skip":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip before the first returned one, for paging (default 0).","title":"Skip"},"fields":{"anyOf":[{"const":"id,name,shortName,description,archived,leader(fullName)","type":"string"},{"type":"null"}],"default":"id,name,shortName,description,archived,leader(fullName)","description":"Fixed field selection sent to YouTrack; leave as is.","title":"Fields"}},"required":["site"],"title":"list_projectsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_project_custom_fields":{"post":{"operationId":"list_project_custom_fields","summary":"List the custom fields attached to a project: field name, type, whether it may be empty, whether it is public and its or","description":"List the custom fields attached to a project: field name, type, whether it may be empty, whether it is public and its order. Use for \"Which custom fields does YouTrack project 0-0 use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your YouTrack Cloud name: the part before .youtrack.cloud, for example 'mycompany' for mycompany.youtrack.cloud.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"project_id":{"description":"Database id of the project, for example '0-0' (from list_projects).","maxLength":40,"title":"Project Id","type":"string"},"top":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Top"},"skip":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip before the first returned one, for paging (default 0).","title":"Skip"},"fields":{"anyOf":[{"const":"id,canBeEmpty,emptyFieldText,isPublic,ordinal,field(name,fieldType(id))","type":"string"},{"type":"null"}],"default":"id,canBeEmpty,emptyFieldText,isPublic,ordinal,field(name,fieldType(id))","description":"Fixed field selection sent to YouTrack; leave as is.","title":"Fields"}},"required":["site","project_id"],"title":"list_project_custom_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_agile_boards":{"post":{"operationId":"list_agile_boards","summary":"List agile boards with id, name and owner. Use for \"Which agile boards exist in YouTrack\".","description":"List agile boards with id, name and owner. Use for \"Which agile boards exist in YouTrack\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your YouTrack Cloud name: the part before .youtrack.cloud, for example 'mycompany' for mycompany.youtrack.cloud.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"top":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Top"},"skip":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip before the first returned one, for paging (default 0).","title":"Skip"},"fields":{"anyOf":[{"const":"id,name,owner(fullName)","type":"string"},{"type":"null"}],"default":"id,name,owner(fullName)","description":"Fixed field selection sent to YouTrack; leave as is.","title":"Fields"}},"required":["site"],"title":"list_agile_boardsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_sprints":{"post":{"operationId":"list_sprints","summary":"List the sprints of an agile board: name, goal, start and finish, archived and default flags and unresolved issue count.","description":"List the sprints of an agile board: name, goal, start and finish, archived and default flags and unresolved issue count. Use for \"What sprints does YouTrack board 108-1 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your YouTrack Cloud name: the part before .youtrack.cloud, for example 'mycompany' for mycompany.youtrack.cloud.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"agile_id":{"description":"Database id of the agile board, for example '108-1' (from list_agile_boards).","maxLength":40,"title":"Agile Id","type":"string"},"top":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Top"},"skip":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip before the first returned one, for paging (default 0).","title":"Skip"},"fields":{"anyOf":[{"const":"id,name,goal,start,finish,archived,isDefault,unresolvedIssuesCount","type":"string"},{"type":"null"}],"default":"id,name,goal,start,finish,archived,isDefault,unresolvedIssuesCount","description":"Fixed field selection sent to YouTrack; leave as is.","title":"Fields"}},"required":["site","agile_id"],"title":"list_sprintsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_saved_queries":{"post":{"operationId":"list_saved_queries","summary":"List saved searches visible to the key's user: name, query text and owner. Use for \"Which saved searches exist in YouTra","description":"List saved searches visible to the key's user: name, query text and owner. Use for \"Which saved searches exist in YouTrack\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your YouTrack Cloud name: the part before .youtrack.cloud, for example 'mycompany' for mycompany.youtrack.cloud.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"top":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Top"},"skip":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip before the first returned one, for paging (default 0).","title":"Skip"},"fields":{"anyOf":[{"const":"id,name,query,owner(fullName)","type":"string"},{"type":"null"}],"default":"id,name,query,owner(fullName)","description":"Fixed field selection sent to YouTrack; leave as is.","title":"Fields"}},"required":["site"],"title":"list_saved_queriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_tags":{"post":{"operationId":"list_tags","summary":"List tags visible to the key's user with id, name, owner and whether the tag is removed when an issue resolves; filter b","description":"List tags visible to the key's user with id, name, owner and whether the tag is removed when an issue resolves; filter by name. Use for \"Which tags exist in YouTrack\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your YouTrack Cloud name: the part before .youtrack.cloud, for example 'mycompany' for mycompany.youtrack.cloud.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only tags whose name matches this text.","title":"Query"},"top":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Top"},"skip":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip before the first returned one, for paging (default 0).","title":"Skip"},"fields":{"anyOf":[{"const":"id,name,untagOnResolve,owner(fullName)","type":"string"},{"type":"null"}],"default":"id,name,untagOnResolve,owner(fullName)","description":"Fixed field selection sent to YouTrack; leave as is.","title":"Fields"}},"required":["site"],"title":"list_tagsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_issue_link_types":{"post":{"operationId":"list_issue_link_types","summary":"List the issue link types (Relates, Depend, Duplicate, Subtask ...) with their wording in both directions and whether th","description":"List the issue link types (Relates, Depend, Duplicate, Subtask ...) with their wording in both directions and whether they are directed. Use for \"What link types can YouTrack issues have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your YouTrack Cloud name: the part before .youtrack.cloud, for example 'mycompany' for mycompany.youtrack.cloud.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"top":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Top"},"skip":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip before the first returned one, for paging (default 0).","title":"Skip"},"fields":{"anyOf":[{"const":"id,name,sourceToTarget,targetToSource,directed,aggregation","type":"string"},{"type":"null"}],"default":"id,name,sourceToTarget,targetToSource,directed,aggregation","description":"Fixed field selection sent to YouTrack; leave as is.","title":"Fields"}},"required":["site"],"title":"list_issue_link_typesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}