Context7 如何添加私有文档源供 AI 助手查询【免费下载链接】context7Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors项目地址: https://gitcode.com/gh_mirrors/co/context7你的团队有一份内部文档Git 仓库、Confluence 空间或 OpenAPI 规范希望 AI 编程助手在写代码时能查到这些私有资料而不是只依赖模型训练数据。Context7 支持把这类私有文档源加入 teamspace解析并索引后AI 助手和 API 就能通过私有源的 library ID 查询它。本文按 Context7 官方文档给出添加私有源的完整操作路径前提条件、控制台添加步骤、context7.json解析控制、用 API 验证可查询性以及让 AI 助手使用你自己的 API key。适用前提来自文档先核对添加私有源需要Pro 或 Enterprise 套餐Free 套餐只能添加公开库需要有一个 teamspace并且你的角色是Owner 或 AdminDeveloper 只能查看源文档不能添加、刷新或删除私有源验证和 AI 助手接入需要 API key格式为ctx7sk-...在 Context7 dashboard 的 API Keys 卡片创建创建后只显示一次需立即保存。在 teamspace 的 Sources 页添加私有源主路径在控制台完成步骤来自 私有源文档进入 teamspace 的Sources标签页。点击Add another打开源类型选择器。可选的源类型有GitHub— 连接 GitHub 账户并选择仓库GitLab— 连接 GitLab 账户并选择项目Bitbucket— 连接 Bitbucket 账户并选择仓库Other Git— 通过 URL 添加任意 Git 仓库Confluence— 连接 Confluence 工作区OpenAPI— 添加 OpenAPI 规范。按提示授权 Context7 访问该源需要时。可选勾选Generate docs。当仓库几乎没有成文文档时Context7 会从源码生成文档。这一点公开仓库是自动回退私有仓库是显式开启的API 方式对应generateDocs标志。提交解析。如果还没有 teamspace先创建从 dashboard 左上角下拉菜单选择Create a teamspace并命名。teamspace 成员限制为Free 仅 1 人个人Pro 最多 10 人Enterprise 不限只有 teamspace owner 需要付费套餐受邀成员不需要自己的订阅。详见 teamspace 文档。可选用 context7.json 控制解析范围如果要更精细地控制 Context7 解析哪些内容可以在仓库根目录提交一个context7.json文件。它控制的是 Context7去哪里找文档而不是读什么类型的文件解析的文件类型为.md、.mdx、.markdown、.rst、.txt、.ipynb见 Adding Libraries。完整字段说明见 Library Owners常用配置如下{ $schema: https://context7.com/schema/context7.json, projectTitle: Your Project Name, description: Brief description of your project, folders: [docs, guides], excludeFolders: [tests, dist, node_modules], excludeFiles: [CHANGELOG.md], branch: main, rules: [Always validate user input, Use TypeScript strict mode] }各字段的作用以官方文档描述为准folders只解析列出的目录为空则扫描整个仓库根级 markdown 文件始终包含。excludeFolders支持简单目录名、路径、glob 模式如**/dist、docs/**/internal。excludeFolders的优先级始终高于folders文件路径命中排除模式就直接排除folders非空且文件不在其中则排除其余才纳入。excludeFiles按文件名排除只写文件名不写路径。未指定时 Context7 有一组默认排除如CHANGELOG.md、LICENSE.md、各类*archive*、i18n/zh*等目录。branch指定要解析的 git 分支不提供时使用默认分支。rules写给编码 agent 的最佳实践提示会作为建议出现在提供给 coding agents 的文档上下文中。previousVersions/branchVersions让旧版本按 tag 或按分支也可在 Context7 中查询。$schema字段可让编辑器提供自动补全和校验。验证私有文档已可被查询添加并解析完成后用 API 直接查询私有源确认它已可被 AI 助手拿到。私有 Git 仓库的 library ID 形如/owner/repo见 API Guide。所有 API 请求都要在Authorization头携带 API keycurl https://context7.com/api/v2/context?libraryId/owner/repoqueryyour%20question \ -H Authorization: Bearer YOUR_API_KEY把YOUR_API_KEY替换为你在 dashboard 创建的 key把/owner/repo替换为你添加的私有仓库的 library ID即 context7.com 上该库页面的 URL 路径。查询建议用具体的自然语言问题而不是单个词效果与响应都更好。按 API 文档的错误码判断结果状态码含义处理200成功正常处理响应401API key 无效检查 key 格式应以ctx7sk开头403无权限检查库的访问权限或套餐404库不存在核对 library ID错误响应是带error和message字段的 JSON例如{ error: library_not_found, message: Library \/owner/repo\ not found. Please check the library ID or your access permissions. }费用也可以核对在 teamspace 的Overview标签页可以看到 Parsing Tokens 指标添加新的私有源会计费刷新时只对变更内容计费缓存页面不收费见 Monitor Usage。让 AI 助手使用你自己的私有源AI 助手接入 Context7 后查询私有库时用的身份取决于认证方式。以 Claude Code 为例见 Claude Code 客户端文档一键配置npx ctx7 setup --claude该流程通过 OAuth 认证、生成 API key 并安装对应的 skill可选择 CLI 或 MCP 模式使用自己的 key 而非匿名额度在 dashboard 创建 API key 后启动前导出环境变量插件会自动读取# e.g. in ~/.zshrc or ~/.bashrc export CONTEXT7_API_KEYyour-api-key设置后重启 Claude Code可在 dashboard 确认请求计入你自己的套餐。未设置该变量时插件仍可用但请求走匿名层速率限制更低。注意私有源对查询方的可见性由 teamspace 的角色和套餐决定——Developer 角色可以查看源文档但要能管理源本身需要 Owner 或 Admin。团队内的助手账号若查不到私有库先核对该成员的 teamspace 角色。刷新与删除私有源添加后不会自动保持最新需要手动刷新点击源旁边的刷新图标Context7 重新解析且只对变更内容计费。文档建议在文档有重大更新、发布新功能或发现信息过时后刷新不要频繁刷新以控制成本。删除源点击源旁边的垃圾桶图标并在弹窗中确认。该操作不可逆确认后源文档立即不可用API 也无法再访问该源。限制与注意事项计划要求私有源功能仅 Pro / Enterprise 可用公开库走 context7.com 的 Add Library 页面与私有源流程不同。角色要求仅 Owner 与 Admin 可添加、刷新、删除私有源。解析范围context7.json只影响从哪里找不会改变被解析的文件类型私有仓库从源码生成文档必须显式勾选Generate docs或 API 传generateDocs不会像公开仓库那样自动回退。【免费下载链接】context7Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors项目地址: https://gitcode.com/gh_mirrors/co/context7创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Context7 如何添加私有文档源供 AI 助手查询？
Context7 如何添加私有文档源供 AI 助手查询【免费下载链接】context7Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors项目地址: https://gitcode.com/gh_mirrors/co/context7你的团队有一份内部文档Git 仓库、Confluence 空间或 OpenAPI 规范希望 AI 编程助手在写代码时能查到这些私有资料而不是只依赖模型训练数据。Context7 支持把这类私有文档源加入 teamspace解析并索引后AI 助手和 API 就能通过私有源的 library ID 查询它。本文按 Context7 官方文档给出添加私有源的完整操作路径前提条件、控制台添加步骤、context7.json解析控制、用 API 验证可查询性以及让 AI 助手使用你自己的 API key。适用前提来自文档先核对添加私有源需要Pro 或 Enterprise 套餐Free 套餐只能添加公开库需要有一个 teamspace并且你的角色是Owner 或 AdminDeveloper 只能查看源文档不能添加、刷新或删除私有源验证和 AI 助手接入需要 API key格式为ctx7sk-...在 Context7 dashboard 的 API Keys 卡片创建创建后只显示一次需立即保存。在 teamspace 的 Sources 页添加私有源主路径在控制台完成步骤来自 私有源文档进入 teamspace 的Sources标签页。点击Add another打开源类型选择器。可选的源类型有GitHub— 连接 GitHub 账户并选择仓库GitLab— 连接 GitLab 账户并选择项目Bitbucket— 连接 Bitbucket 账户并选择仓库Other Git— 通过 URL 添加任意 Git 仓库Confluence— 连接 Confluence 工作区OpenAPI— 添加 OpenAPI 规范。按提示授权 Context7 访问该源需要时。可选勾选Generate docs。当仓库几乎没有成文文档时Context7 会从源码生成文档。这一点公开仓库是自动回退私有仓库是显式开启的API 方式对应generateDocs标志。提交解析。如果还没有 teamspace先创建从 dashboard 左上角下拉菜单选择Create a teamspace并命名。teamspace 成员限制为Free 仅 1 人个人Pro 最多 10 人Enterprise 不限只有 teamspace owner 需要付费套餐受邀成员不需要自己的订阅。详见 teamspace 文档。可选用 context7.json 控制解析范围如果要更精细地控制 Context7 解析哪些内容可以在仓库根目录提交一个context7.json文件。它控制的是 Context7去哪里找文档而不是读什么类型的文件解析的文件类型为.md、.mdx、.markdown、.rst、.txt、.ipynb见 Adding Libraries。完整字段说明见 Library Owners常用配置如下{ $schema: https://context7.com/schema/context7.json, projectTitle: Your Project Name, description: Brief description of your project, folders: [docs, guides], excludeFolders: [tests, dist, node_modules], excludeFiles: [CHANGELOG.md], branch: main, rules: [Always validate user input, Use TypeScript strict mode] }各字段的作用以官方文档描述为准folders只解析列出的目录为空则扫描整个仓库根级 markdown 文件始终包含。excludeFolders支持简单目录名、路径、glob 模式如**/dist、docs/**/internal。excludeFolders的优先级始终高于folders文件路径命中排除模式就直接排除folders非空且文件不在其中则排除其余才纳入。excludeFiles按文件名排除只写文件名不写路径。未指定时 Context7 有一组默认排除如CHANGELOG.md、LICENSE.md、各类*archive*、i18n/zh*等目录。branch指定要解析的 git 分支不提供时使用默认分支。rules写给编码 agent 的最佳实践提示会作为建议出现在提供给 coding agents 的文档上下文中。previousVersions/branchVersions让旧版本按 tag 或按分支也可在 Context7 中查询。$schema字段可让编辑器提供自动补全和校验。验证私有文档已可被查询添加并解析完成后用 API 直接查询私有源确认它已可被 AI 助手拿到。私有 Git 仓库的 library ID 形如/owner/repo见 API Guide。所有 API 请求都要在Authorization头携带 API keycurl https://context7.com/api/v2/context?libraryId/owner/repoqueryyour%20question \ -H Authorization: Bearer YOUR_API_KEY把YOUR_API_KEY替换为你在 dashboard 创建的 key把/owner/repo替换为你添加的私有仓库的 library ID即 context7.com 上该库页面的 URL 路径。查询建议用具体的自然语言问题而不是单个词效果与响应都更好。按 API 文档的错误码判断结果状态码含义处理200成功正常处理响应401API key 无效检查 key 格式应以ctx7sk开头403无权限检查库的访问权限或套餐404库不存在核对 library ID错误响应是带error和message字段的 JSON例如{ error: library_not_found, message: Library \/owner/repo\ not found. Please check the library ID or your access permissions. }费用也可以核对在 teamspace 的Overview标签页可以看到 Parsing Tokens 指标添加新的私有源会计费刷新时只对变更内容计费缓存页面不收费见 Monitor Usage。让 AI 助手使用你自己的私有源AI 助手接入 Context7 后查询私有库时用的身份取决于认证方式。以 Claude Code 为例见 Claude Code 客户端文档一键配置npx ctx7 setup --claude该流程通过 OAuth 认证、生成 API key 并安装对应的 skill可选择 CLI 或 MCP 模式使用自己的 key 而非匿名额度在 dashboard 创建 API key 后启动前导出环境变量插件会自动读取# e.g. in ~/.zshrc or ~/.bashrc export CONTEXT7_API_KEYyour-api-key设置后重启 Claude Code可在 dashboard 确认请求计入你自己的套餐。未设置该变量时插件仍可用但请求走匿名层速率限制更低。注意私有源对查询方的可见性由 teamspace 的角色和套餐决定——Developer 角色可以查看源文档但要能管理源本身需要 Owner 或 Admin。团队内的助手账号若查不到私有库先核对该成员的 teamspace 角色。刷新与删除私有源添加后不会自动保持最新需要手动刷新点击源旁边的刷新图标Context7 重新解析且只对变更内容计费。文档建议在文档有重大更新、发布新功能或发现信息过时后刷新不要频繁刷新以控制成本。删除源点击源旁边的垃圾桶图标并在弹窗中确认。该操作不可逆确认后源文档立即不可用API 也无法再访问该源。限制与注意事项计划要求私有源功能仅 Pro / Enterprise 可用公开库走 context7.com 的 Add Library 页面与私有源流程不同。角色要求仅 Owner 与 Admin 可添加、刷新、删除私有源。解析范围context7.json只影响从哪里找不会改变被解析的文件类型私有仓库从源码生成文档必须显式勾选Generate docs或 API 传generateDocs不会像公开仓库那样自动回退。【免费下载链接】context7Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors项目地址: https://gitcode.com/gh_mirrors/co/context7创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考