Skip to content

Context7 Platform -- Up-to-date docs for AI agents

Merge remote-tracking branch 'origin' into docs

enesgules7bc0f4fc325d
diff --cc README.md
index 8d7fde53,26e62f4f..2fc3305a
--- a/README.md
+++ b/README.md
@@@ -4,9 -6,7 +6,7 @@@
[![Website](https://img.shields.io/badge/Website-context7.com-blue)](https://context7.com) [![smithery badge](https://smithery.ai/badge/@upstash/context7-mcp)](https://smithery.ai/server/@upstash/context7-mcp) [![NPM Version](https://img.shields.io/npm/v/%40upstash%2Fcontext7-mcp?color=red)](https://www.npmjs.com/package/@upstash/context7-mcp) [![MIT licensed](https://img.shields.io/npm/l/%40upstash%2Fcontext7-mcp)](./LICENSE)
- [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=context7&config=eyJ1cmwiOiJodHRwczovL21jcC5jb250ZXh0Ny5jb20vbWNwIn0%3D) [<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/Install%20in%20VS%20Code-0098FF?style=for-the-badge&logo=visualstudiocode&logoColor=white">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22context7%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fcontext7-mcp%40latest%22%5D%7D)
-
-[![繁體中文](https://img.shields.io/badge/docs-繁體中文-yellow)](./docs/README.zh-TW.md) [![简体中文](https://img.shields.io/badge/docs-简体中文-yellow)](./docs/README.zh-CN.md) [![日本語](https://img.shields.io/badge/docs-日本語-b7003a)](./docs/README.ja.md) [![한국어 문서](https://img.shields.io/badge/docs-한국어-green)](./docs/README.ko.md) [![Documentación en Español](https://img.shields.io/badge/docs-Español-orange)](./docs/README.es.md) [![Documentation en Français](https://img.shields.io/badge/docs-Français-blue)](./docs/README.fr.md) [![Documentação em Português (Brasil)](<https://img.shields.io/badge/docs-Português%20(Brasil)-purple>)](./docs/README.pt-BR.md) [![Documentazione in italiano](https://img.shields.io/badge/docs-Italian-red)](./docs/README.it.md) [![Dokumentasi Bahasa Indonesia](https://img.shields.io/badge/docs-Bahasa%20Indonesia-pink)](./docs/README.id-ID.md) [![Dokumentation auf Deutsch](https://img.shields.io/badge/docs-Deutsch-darkgreen)](./docs/README.de.md) [![Документация на русском языке](https://img.shields.io/badge/docs-Русский-darkblue)](./docs/README.ru.md) [![Українська документація](https://img.shields.io/badge/docs-Українська-lightblue)](./docs/README.uk.md) [![Türkçe Doküman](https://img.shields.io/badge/docs-Türkçe-blue)](./docs/README.tr.md) [![Arabic Documentation](https://img.shields.io/badge/docs-Arabic-white)](./docs/README.ar.md) [![Tiếng Việt](https://img.shields.io/badge/docs-Tiếng%20Việt-red)](./docs/README.vi.md)
+[![繁體中文](https://img.shields.io/badge/docs-繁體中文-yellow)](./i18n/README.zh-TW.md) [![简体中文](https://img.shields.io/badge/docs-简体中文-yellow)](./i18n/README.zh-CN.md) [![日本語](https://img.shields.io/badge/docs-日本語-b7003a)](./i18n/README.ja.md) [![한국어 문서](https://img.shields.io/badge/docs-한국어-green)](./i18n/README.ko.md) [![Documentación en Español](https://img.shields.io/badge/docs-Español-orange)](./i18n/README.es.md) [![Documentation en Français](https://img.shields.io/badge/docs-Français-blue)](./i18n/README.fr.md) [![Documentação em Português (Brasil)](<https://img.shields.io/badge/docs-Português%20(Brasil)-purple>)](./i18n/README.pt-BR.md) [![Documentazione in italiano](https://img.shields.io/badge/docs-Italian-red)](./i18n/README.it.md) [![Dokumentasi Bahasa Indonesia](https://img.shields.io/badge/docs-Bahasa%20Indonesia-pink)](./i18n/README.id-ID.md) [![Dokumentation auf Deutsch](https://img.shields.io/badge/docs-Deutsch-darkgreen)](./i18n/README.de.md) [![Документация на русском языке](https://img.shields.io/badge/docs-Русский-darkblue)](./i18n/README.ru.md) [![Українська документація](https://img.shields.io/badge/docs-Українська-lightblue)](./i18n/README.uk.md) [![Türkçe Doküman](https://img.shields.io/badge/docs-Türkçe-blue)](./i18n/README.tr.md) [![Arabic Documentation](https://img.shields.io/badge/docs-Arabic-white)](./i18n/README.ar.md) [![Tiếng Việt](https://img.shields.io/badge/docs-Tiếng%20Việt-red)](./i18n/README.vi.md)
## ❌ Without Context7
diff --cc docs/adding-libraries.mdx
index d0e2ebcc,01dcb924..55814ac8
--- a/docs/adding-libraries.mdx
+++ b/docs/adding-libraries.mdx
@@@ -49,23 -39,37 +48,26 @@@ Here's an example `context7.json` file
## Field Descriptions
-- **`projectTitle`** (string): Suggested display name for your project in Context7. Only used when LLM
- can not generate a name with high confidence.
+- **`projectTitle`** (string): Suggested display name for your project in Context7. Only used when LLM can not generate a name with high confidence.
-- **`description`** (string): Suggested description for your project in Context7. Only used when LLM can
- not generate a name with high confidence.
+- **`description`** (string): Suggested description for your project in Context7. Only used when LLM can not generate a name with high confidence.
-- **`branch`** (string): The name of the git branch to parse. If not provided, the default branch will
- be used.
+- **`branch`** (string): The name of the git branch to parse. If not provided, the default branch will be used.
-- **`folders`** (array): Specific folder paths to include when parsing documentation. If empty, Context7
- will scan the entire repository for relevant documentation files. Note: Root-level markdown files are
- always included regardless of this setting.
+- **`folders`** (array): Specific folder paths to include when parsing documentation. If empty, Context7 will scan the entire repository for relevant documentation files. Note: Root-level markdown files are always included regardless of this setting.
-- **`excludeFolders`** (array): Patterns to exclude folders and paths from documentation parsing.
- Supports simple names, paths, and glob patterns (see Exclusion Patterns section below).
+- **`excludeFolders`** (array): Patterns to exclude folders and paths from documentation parsing. Supports simple names, paths, and glob patterns (see Exclusion Patterns section below).
-- **`excludeFiles`** (array): Specific file names to exclude from documentation parsing. Only include
- the filename (not the path). Useful for excluding files like `CHANGELOG.md`, license files, or other
- non-documentation content.
+- **`excludeFiles`** (array): Specific file names to exclude from documentation parsing. Only include the filename (not the path). Useful for excluding files like `CHANGELOG.md`, license files, or other non-documentation content.
-- **`rules`** (array): Best practices or important guidelines that coding agents should follow when
- using your library. These appear as recommendations in the documentation context provided to coding
- agents.
+- **`rules`** (array): Best practices or important guidelines that coding agents should follow when using your library. These appear as recommendations in the documentation context provided to coding agents.
-- **`previousVersions`** (array): Information about previous versions of your library that should also
- be available in Context7.
+- **`previousVersions`** (array): Information about previous versions of your library that should also be available in Context7.
- **`tag`**: The Git tag or version identifier
- - **`title`**: Human-readable version name
+
+ - **`branchVersions`** (array): Information about previous versions (branch based) of your library that should also
+ be available in Context7.
+ - **`branch`**: The Git branch
### Exclusion Patterns