Add Context7 instructions for authoritative external documentation usage#727
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new repository-wide custom instruction that guides Copilot/agents to use Context7 for authoritative, version-specific external documentation when local repo context is insufficient.
Changes:
- Added
instructions/context7.instructions.mddescribing when/how to use Context7 and an MCP tool workflow. - Updated
docs/README.instructions.mdto include the new instruction in the instructions index.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| instructions/context7.instructions.md | Introduces Context7 usage guidance and an MCP-based workflow for resolving libraries and fetching docs. |
| docs/README.instructions.md | Adds an index entry so the new instruction is discoverable/installable. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
npm start generate the following title |
aaronpowell
left a comment
There was a problem hiding this comment.
I don't think that this is a valuable addition. We already have a context7 agent in the repo and given that agents can define a MCP server as part of their frontmatter plus are able to be shipped in plugins, which instructions cannot, this has diminishing value to users.
Thanks for the feedback. I see your point about the existing context7 agent already being in the repo and it's distinct advantage over instructions. But the context7 agent instructions only applies if we use the agent. For the default Plan and Agent this instructions does not apply. I use this instructions when working with the default agents, custom agents and it works well as intended ( copilot uses context7 without me typing use context7 in every prompt ). Also I made this as a copilot alternative to this cursor rule https://context7.com/docs/tips#add-a-rule |
|
It might be worth considering removing the agent and instead replacing it with a skill crafted off this. Skills can be picked up by any agent (or manually invoked), and they are more distributable using plugins (which don't support instructions). |
|
As noted in #751 we are changing the process for contributing and using a branch, Can you retarget this branch to |
I'm do not know how widely used the Context7 agent is, nor have I used it myself, so I can’t confidently weigh in on whether it should be removed. I could try creating a skill based on this, but I’ll need some time to experiment and test it, as I'm still fairly new to SKILL.md. |
The merge-base changed after approval.
|
@all-contributors add @username for Instructions |
|
I couldn't determine any contributions to add, did you specify any contributions? |
|
@all-contributors add @lance2k for Instructions |
|
I couldn't determine any contributions to add, did you specify any contributions? |
|
@all-contributors please add @lance2k for code |
Pull Request Checklist
npm startand verified that README.md is up to date.Description
Add a new repository-wide instruction document describing how and when to use Context7 for retrieving authoritative external documentation and examples. The instruction provides workflow steps and guidance for resolving library IDs and querying Context7 for version-sensitive API docs. This helps agents and contributors fetch up-to-date external docs when local context is insufficient.
File added: context7.instructions.md
Usage notes:
Type of Contribution
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.