Skip to content

fix: MCP stdio transport and add tool descriptions#56

Open
skmahe1077 wants to merge 3 commits intopipe-cd:mainfrom
skmahe1077:fix/console-info-stdout-55
Open

fix: MCP stdio transport and add tool descriptions#56
skmahe1077 wants to merge 3 commits intopipe-cd:mainfrom
skmahe1077:fix/console-info-stdout-55

Conversation

@skmahe1077
Copy link
Copy Markdown
Contributor

This pull request improves the developer experience and API usability for the PipeCD docs tools by adding helpful descriptions to the API methods and making minor logging adjustments. The key changes are grouped below:

API usability improvements:

  • Added descriptive text for the search_docs tool, clarifying that it performs a full-text AND search over PipeCD docs using space-separated keywords.
  • Enhanced the read_docs tool by providing a clear description of its purpose and usage, specifying that it returns the full content of a specified doc page and how to provide the path.

Logging changes:

  • Changed log messages from console.info to console.error in src/loader.ts for both the start and successful completion of the repository cloning process. [1] [2]

After modified MCP Server working fine locally and we need to create the new release

image

skmahe1077 and others added 3 commits April 10, 2026 00:08
Signed-off-by: Mahendran Selvakumar <skmahe1077@gmail.com>
* Fix Cursor deeplink URL returning 404 error

Signed-off-by: Mahendran Selvakumar <skmahe1077@gmail.com>

* Fix Cursor deeplink to use HTML anchor tag for GitHub compatibility

Signed-off-by: Mahendran Selvakumar <skmahe1077@gmail.com>

* Fix Cursor deeplink to use correct install URL

Signed-off-by: Mahendran Selvakumar <skmahe1077@gmail.com>

---------

Signed-off-by: Mahendran Selvakumar <skmahe1077@gmail.com>
Signed-off-by: Mahendran Selvakumar <skmahe1077@gmail.com>
@skmahe1077 skmahe1077 force-pushed the fix/console-info-stdout-55 branch from 253fc7b to 260213f Compare April 9, 2026 23:09

try {
console.info(`Start cloning repo ${REPO} to ${targetDir}`);
console.error(`Start cloning repo ${REPO} to ${targetDir}`);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why should we use error over info here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

In a normal Node app console.info is fine. But MCP servers communicate over stdio, the client reads stdout expecting only valid JSON. Any non-JSON text (like "Successfully cloned...") breaks the protocol.console.error here doesn't mean something went wrong, it just routes the message to stderr, which MCP clients ignore (or display in debug logs)

Copy link
Copy Markdown

@eeshaanSA eeshaanSA left a comment

Choose a reason for hiding this comment

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

Looks good. I am just not sure about console.error, I will check once on this. Your reply looks solid.

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.

3 participants