Skip to content

Conversation

@rosieyohannan
Copy link
Contributor

@rosieyohannan rosieyohannan commented Apr 23, 2025

Description

  • Add overview page for using the mcp server
  • Add page to the side nav under Developer Toolkit section
  • Add required lint rules
  • Add example screenshot showing Cursor settings

Reasons

Support release

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.

@rosieyohannan rosieyohannan changed the title Add overview page for the CIrcleCI MCP server Add overview page for the CircleCI MCP server Apr 23, 2025
@rosieyohannan rosieyohannan marked this pull request as ready for review April 23, 2025 12:54
@rosieyohannan rosieyohannan requested review from a team as code owners April 23, 2025 12:54
Copy link

@stiyyagura0901 stiyyagura0901 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we consider adding a "Troubleshooting" section to address common issues users might encounter.

eg:
Troubleshooting

  • Updating Available Tools: After new tools are released, you may need to restart your MCP server to access them. Simply reload your IDE window to ensure the CircleCI MCP server loads the most recently released tools and capabilities.

@rosieyohannan rosieyohannan merged commit 1dbc437 into master Apr 25, 2025
3 checks passed
@pete-woods pete-woods deleted the DOCSS-1772-add-doc-for-mcp-server branch August 8, 2025 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants