https://github.com/janwilmake/contextjson
Standard for LLM Context
https://github.com/janwilmake/contextjson
Last synced: 14 days ago
JSON representation
Standard for LLM Context
- Host: GitHub
- URL: https://github.com/janwilmake/contextjson
- Owner: janwilmake
- Created: 2025-05-09T06:16:23.000Z (16 days ago)
- Default Branch: main
- Last Pushed: 2025-05-09T07:17:29.000Z (15 days ago)
- Last Synced: 2025-05-09T07:29:08.220Z (15 days ago)
- Language: JavaScript
- Homepage: https://contextjson.com
- Size: 10.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - janwilmake/contextjson - Standard for LLM Context (JavaScript)
README
# [`context.json`](https://github.com/janwilmake/contextjson) - 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:
```json
{
"$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`.