docs: document the Context Management API in the API and MCP guides - #582
Merged
Merged
Conversation
- OpenAPI overview: replace project:context:read, which no public endpoint checks, with org:context:read / org:context:write; say that Context Management needs an Organization key and that Context Group routes use the group's Organization; add Context Management to the default rate limit; add a Pagination section; generalize 409 and note the 1 MiB Context Management response limit under 413. - For coding agents: describe the MCP Context Management tools, their permissions, and orgId/groupId targeting. - API keys and API reference: say what the Organization Context permission unlocks and list Context Management among API capabilities. - Defining context guide: point developers at the API and MCP tools for automating Context Group changes.
eoinest
approved these changes
Oct 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Summary
The Context Management API (24 operations over HTTP and MCP) is live, and its generated reference pages are already published. The hand-written guides around them hadn't caught up yet:
project:context:read, which no public endpoint checks, and listedorg:context:readandorg:context:write. Also states that Context Management needs an Organization key, since project keys can't hold these permissions./v2/context-groups/{groupId}) use the Organization that owns the group.{ items, nextCursor },limit(1–100, default 50),cursor, and how cursors are tied to the list that issued them.409now covers Glossary term and Custom Prompt rename conflicts, and413mentions the 1 MiB Context Management response limit.orgIdorgroupId.Evidence
I checked every claim against gt-cloud
mainbefore writing it:operations/context/**authorization;packages/node/src/auth/apiKeyPermissions.ts(project keys can't grantorg:*);project:context:readisn't referenced inapps/api/src.contextGroupAuthorizationresolves the Organization fromgroupId.context-managementhas no explicit limit, so it gets the 200/min default; context generation usesmediumRequestLimit.packages/settings/src/pagination.tsanddefineListOperationcursor binding.POST /v2/orgs/{orgId}/projects,POST /v2/project/branches/create, and the glossary and custom-promptPATCHroutes inopenapi.public.json.operations/context/management.ts.validate-links,validate:unsafe-html,validate:callouts,validate:reference-linksandvalidate:structureall pass.Following the AGENTS.md authentication boundary, HTTP prose mentions only API keys. Sign-in is mentioned only in the MCP section, where OAuth sign-in is a customer workflow.
Merge Danger
Door: two-way. Prose-only changes to five hand-written pages; nothing generated is touched.
Blast radius: docs only.