contextjson

context.json - Standard for LLM Context

context.json is a proposed standard for context building which allows instructing LLMs (and humans alike) which contexts are useful for building with your codebase.

Find the schema at https://contextjson.com/schema

Create a context for your package/repo:

To start using context.json, create a context.json file at the root of your repository with these contents:

{
  "$schema": "https://contextjson.com/schema",
  "context": {
    "example": {
      "summary": "This is an example context. Change it into yours",
      "pathPatterns": []
    }
  }
}

Create a context for another package/repo:

If you want to create a context for another package that you use as a dependency, you can do this by deploying a package to npm with the -context suffix, i.e. [packagename]-context or @yourusername/[packagename]-context. In the future, these packages will automatically be indexed and reviewed by the context.json agent.

Deploy your context to the web as well

If your repo is deployed at a website and you want AI to understand context for this website as well, ensure context.json is made available at https://yourdomain.com/context.json, and also make a package.json available at https://yourdomain.com/package.json with the "repository" field, to tell which files are used for the deployed context.json.