QBCore Community Documentation

Independent QBCore API, resource and troubleshooting docs with cited sources.

Should I use this

Quality & Safety

A
Description quality
100%
Schema completeness
77%
Naming quality
80%
Poisoning risk
100%
Permission match
100%
Protocol compliance
100%

Based on automated analysis of tool definitions and protocol compliance.

Context Cost

~1,313Tokens (tool definitions)
~4.3 KBTypical response size
Moderate attention impact (1.03% of 128k context)

This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.

Install

One-Click Install

Add this to your `claude_desktop_config.json` file:

{
  "mcpServers": {
    "qbcore-docs": {
      "url": "https://qbcore.net/api/mcp"
    }
  }
}

Remote endpoints

https://qbcore.net/api/mcpstreamable-http

What it can do

Tool inventory

Tools (3)

🟢 Read-only🟡 Write🔴 Delete⚪ Unknown
🟢docs_search(query, scope, limit)

Find QBCore APIs, qb-* resources, setup and troubleshooting references. Returns bounded excerpts, canonical citations and recorded source-review metadata. Use docs_get for complete code.

Input Schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 2,
      "maxLength": 256
    },
    "scope": {
      "type": "string",
      "enum": [
        "guides",
        "api",
        "resources",
        "troubleshooting"
      ]
    },
    "limit": {
      "default": 5,
      "type": "integer",
      "minimum": 1,
      "maximum": 10
    }
  },
  "required": [
    "query"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Output Schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "scope": {
            "type": "string",
            "enum": [
              "guides",
              "api",
              "resources",
              "troubleshooting"
            ]
          },
          "provenance": {
            "type": "object",
            "properties": {
              "sourceType": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "upstream": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "verifiedAt": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "verifiedCommit": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "sourceType",
              "upstream",
              "verifiedAt",
              "verifiedCommit"
            ],
            "additionalProperties": false
          },
          "excerpt": {
            "type": "object",
            "properties": {
              "text": {
                "type": "string"
              },
              "offset": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "text",
              "offset"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "path",
          "url",
          "title",
          "description",
          "scope",
          "provenance",
          "excerpt"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "query",
    "results",
    "total"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}
🟢docs_get(path, offset)

Read Markdown at a canonical path returned by docs_search or docs_list. Follow nextOffset until null to obtain the complete article. Does not fetch arbitrary URLs.

Input Schema

{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "maxLength": 240,
      "pattern": "^\\/(?:docs|tutorials|resources|quickstart)(?:\\/[a-z0-9_-]+)*$"
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "required": [
    "path"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Output Schema

{
  "type": "object",
  "properties": {
    "path": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "scope": {
      "type": "string",
      "enum": [
        "guides",
        "api",
        "resources",
        "troubleshooting"
      ]
    },
    "provenance": {
      "type": "object",
      "properties": {
        "sourceType": {
          "type": [
            "string",
            "null"
          ]
        },
        "upstream": {
          "anyOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "null"
            }
          ]
        },
        "verifiedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "verifiedCommit": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "sourceType",
        "upstream",
        "verifiedAt",
        "verifiedCommit"
      ],
      "additionalProperties": false
    },
    "content": {
      "type": "string"
    },
    "format": {
      "type": "string",
      "const": "markdown"
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "totalChars": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "nextOffset": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "path",
    "url",
    "title",
    "description",
    "scope",
    "provenance",
    "content",
    "format",
    "offset",
    "totalChars",
    "nextOffset"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}
🟢docs_list(scope, offset, limit)

Browse the canonical documentation catalog by scope with deterministic pagination. Follow nextOffset until null.

Input Schema

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "guides",
        "api",
        "resources",
        "troubleshooting"
      ]
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 10000
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Output Schema

{
  "type": "object",
  "properties": {
    "pages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "scope": {
            "type": "string",
            "enum": [
              "guides",
              "api",
              "resources",
              "troubleshooting"
            ]
          },
          "provenance": {
            "type": "object",
            "properties": {
              "sourceType": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "upstream": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "verifiedAt": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "verifiedCommit": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "sourceType",
              "upstream",
              "verifiedAt",
              "verifiedCommit"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "path",
          "url",
          "title",
          "description",
          "scope",
          "provenance"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "nextOffset": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "pages",
    "total",
    "nextOffset"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Community

Rate this Server

Evidence

Recent observations

verifiedversion not recorded3 tools