Improve discoverability of docs-mcp-server by mentioning it in the documentation
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 1.4k
- Forks
- 364
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 84
Description
What would you like to be added:
A permanent mention of the PipeCD Docs MCP Server in the official documentation (e.g., in the user guide or a "Tools" section), instead of only in the release blog post.
Currently, the only reference to it in this repo is the announcement blog post from May 2025 (docs/content/en/blog/mcp-server-intro.md). It is not mentioned in the README, the user guide, or the contributor guide.
Why is this needed:
Users searching the docs for how to use PipeCD with AI editors/agents (Cursor, Claude Code, etc.) have no way to discover that an official docs MCP server exists, unless they happen to read a blog post from 2025. Adding it to a permanent docs page would make the tool discoverable to the users it was built for.
I'm happy to send a PR for this if the maintainers agree on where it should be mentioned.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/content/en/blog/mcp-server-intro.md and inspect the user guide, README, and contributor guide to choose an appropriate permanent documentation location. Add a clear mention and link to the PipeCD Docs MCP Server for users of AI editors or agents; done means it appears outside the release blog post in the official docs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100