Skip to content

Add a troubleshooting solution for recent MCP server updates #172

@cdcabrera

Description

@cdcabrera

As a maintainer its always good to provide troubleshooting solutions to end users. With the frequency of MCP server updates there are bound to be cached installs and related issues and we should have a minimal guide available.

Acceptance criteria

  • add a troubleshooting bullet for "how to handle previously cached versions of the MCP server" and symptoms for debugging

  • review and potentially add a better debugging message on startup failure. this may have limited use if typings issues pop up, see centralizing the MCP SDK typings

  • confirm the bug PR template requests node version, agent used

Assumptions and questions

  • re-evaluate the MCP SDK wrapper we use meant to isolate MCP SDK breaking updates under minor semver. We should consider picking the work back up to centralize their typings through said file.

  • this could be considered a 3 part fix

    • immeadiate - expand documentation
    • intermediate - wrap the cli in messaging that points at the expand documentation
    • long-term - centralize the mcp sdk through our existing src/mcpSdk.ts so we can intercept typings and methods that are prone to breaking changes

Jira Issue: PF-4059

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions