{"openapi":"3.1.0","info":{"title":"CurseForge (BYOK) API","version":"0.1.0","description":"CurseForge (BYOK) lets an AI assistant read your own CurseForge data through the CurseForge API with a key you supply (CurseForge API key). Read-only: 10 tools (list_games, get_game, list_categories, search_mods, get_mod, get_mod_description, list_mod_files, get_mod_file, get_file_changelog, list_minecraft_versions). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-curseforge.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-curseforge/docs"},"termsOfService":"https://connectorbay.com/byok-curseforge/terms"},"servers":[{"url":"https://byok-curseforge.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-curseforge/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_games":{"post":{"operationId":"list_games","summary":"List the games available on CurseForge to your key (for example Minecraft is game ID 432) with name, slug and status. Us","description":"List the games available on CurseForge to your key (for example Minecraft is game ID 432) with name, slug and status. Use for \"Which games does CurseForge have mods for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"index":{"anyOf":[{"maximum":9999,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based index of the first result (index plus page_size must stay at or under 10000).","title":"Index"},"page_size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Results per page (1 to 50).","title":"Page Size"}},"title":"list_gamesArguments","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/get_game":{"post":{"operationId":"get_game","summary":"Get one game by ID: name, slug, icon and status. Use for \"Show CurseForge game 432\".","description":"Get one game by ID: name, slug, icon and status. Use for \"Show CurseForge game 432\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"game_id":{"description":"Game ID from list_games, for example 432 for Minecraft.","minimum":1,"title":"Game Id","type":"integer"}},"required":["game_id"],"title":"get_gameArguments","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_categories":{"post":{"operationId":"list_categories","summary":"List the classes (such as Mods, Modpacks, Resource Packs) and categories of a game, with IDs usable as search filters. U","description":"List the classes (such as Mods, Modpacks, Resource Packs) and categories of a game, with IDs usable as search filters. Use for \"What mod categories does Minecraft have on CurseForge\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"game_id":{"description":"Game ID, for example 432 for Minecraft.","minimum":1,"title":"Game Id","type":"integer"},"class_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only categories under this class ID (a class is a top-level section, for example 6 is Mods in Minecraft).","title":"Class Id"},"classes_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to return only the classes.","title":"Classes Only"}},"required":["game_id"],"title":"list_categoriesArguments","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/search_mods":{"post":{"operationId":"search_mods","summary":"Search the mods (projects) of a game by text, category, game version and mod loader, sorted by popularity, downloads, up","description":"Search the mods (projects) of a game by text, category, game version and mod loader, sorted by popularity, downloads, update date and more. Use for \"Find popular Fabric mods for Minecraft 1.20.1 about minimaps\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"game_id":{"description":"Game ID, for example 432 for Minecraft.","minimum":1,"title":"Game Id","type":"integer"},"class_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Section ID from list_categories, for example 6 for Minecraft mods.","title":"Class Id"},"category_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Category ID from list_categories.","title":"Category Id"},"search_filter":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Free text matched against the project name and author.","title":"Search Filter"},"game_version":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Game version string such as '1.20.1'.","title":"Game Version"},"mod_loader_type":{"anyOf":[{"enum":[0,1,2,3,4,5,6],"type":"integer"},{"type":"null"}],"default":null,"description":"Mod loader: 0 any, 1 Forge, 2 Cauldron, 3 LiteLoader, 4 Fabric, 5 Quilt, 6 NeoForge. Must be combined with game_version.","title":"Mod Loader Type"},"sort_field":{"anyOf":[{"enum":[1,2,3,4,5,6,7,8,11,12],"type":"integer"},{"type":"null"}],"default":null,"description":"Sort: 1 featured, 2 popularity, 3 last updated, 4 name, 5 author, 6 total downloads, 7 category, 8 game version, 11 released date, 12 rating.","title":"Sort Field"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"asc or desc.","title":"Sort Order"},"index":{"anyOf":[{"maximum":9999,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based index of the first result (index plus page_size must stay at or under 10000).","title":"Index"},"page_size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 50).","title":"Page Size"}},"required":["game_id"],"title":"search_modsArguments","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/get_mod":{"post":{"operationId":"get_mod","summary":"Get one mod (project) by ID: summary, download count, authors, links, dates and popularity rank. Use for \"Tell me about ","description":"Get one mod (project) by ID: summary, download count, authors, links, dates and popularity rank. Use for \"Tell me about CurseForge mod 238222\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mod_id":{"description":"CurseForge project (mod) ID, for example 238222, from search_mods.","minimum":1,"title":"Mod Id","type":"integer"}},"required":["mod_id"],"title":"get_modArguments","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/get_mod_description":{"post":{"operationId":"get_mod_description","summary":"Get the long description of a mod as HTML (long text; cut off if very large). Use for \"Show the full description of Curs","description":"Get the long description of a mod as HTML (long text; cut off if very large). Use for \"Show the full description of CurseForge mod 238222\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mod_id":{"description":"CurseForge project (mod) ID, for example 238222, from search_mods.","minimum":1,"title":"Mod Id","type":"integer"}},"required":["mod_id"],"title":"get_mod_descriptionArguments","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_mod_files":{"post":{"operationId":"list_mod_files","summary":"List the files (versions) of a mod with release type (1 release, 2 beta, 3 alpha), date, size, downloads, game versions ","description":"List the files (versions) of a mod with release type (1 release, 2 beta, 3 alpha), date, size, downloads, game versions and dependencies. Use for \"What are the latest files of CurseForge mod 238222 for Minecraft 1.20.1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mod_id":{"description":"CurseForge project (mod) ID, for example 238222, from search_mods.","minimum":1,"title":"Mod Id","type":"integer"},"game_version":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only files for this game version, for example '1.20.1'.","title":"Game Version"},"mod_loader_type":{"anyOf":[{"enum":[0,1,2,3,4,5,6],"type":"integer"},{"type":"null"}],"default":null,"description":"Mod loader: 0 any, 1 Forge, 2 Cauldron, 3 LiteLoader, 4 Fabric, 5 Quilt, 6 NeoForge.","title":"Mod Loader Type"},"index":{"anyOf":[{"maximum":9999,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based index of the first result (index plus page_size must stay at or under 10000).","title":"Index"},"page_size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 50).","title":"Page Size"}},"required":["mod_id"],"title":"list_mod_filesArguments","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/get_mod_file":{"post":{"operationId":"get_mod_file","summary":"Get one file of a mod by file ID: name, release type, date, size, game versions and dependencies. Use for \"Show file 500","description":"Get one file of a mod by file ID: name, release type, date, size, game versions and dependencies. Use for \"Show file 5000000 of CurseForge mod 238222\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mod_id":{"description":"CurseForge project (mod) ID, for example 238222, from search_mods.","minimum":1,"title":"Mod Id","type":"integer"},"file_id":{"description":"File ID from list_mod_files.","minimum":1,"title":"File Id","type":"integer"}},"required":["mod_id","file_id"],"title":"get_mod_fileArguments","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/get_file_changelog":{"post":{"operationId":"get_file_changelog","summary":"Get the changelog of a mod file as HTML. Use for \"What changed in file 5000000 of CurseForge mod 238222\".","description":"Get the changelog of a mod file as HTML. Use for \"What changed in file 5000000 of CurseForge mod 238222\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mod_id":{"description":"CurseForge project (mod) ID, for example 238222, from search_mods.","minimum":1,"title":"Mod Id","type":"integer"},"file_id":{"description":"File ID from list_mod_files.","minimum":1,"title":"File Id","type":"integer"}},"required":["mod_id","file_id"],"title":"get_file_changelogArguments","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_minecraft_versions":{"post":{"operationId":"list_minecraft_versions","summary":"List Minecraft game versions known to CurseForge with approval state and release info. Use for \"Which Minecraft versions","description":"List Minecraft game versions known to CurseForge with approval state and release info. Use for \"Which Minecraft versions does CurseForge support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sort_descending":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True to list newest versions first.","title":"Sort Descending"}},"title":"list_minecraft_versionsArguments","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}}}}