keyshade

Keyshade MCP server exposes the Keyshade API integration as an MCP server that communicates over standard input/output with your editor integrations. The server is implemented with Node.js and is started by running the built entry point at build/index.js. To use it, configure your MCP client (such as VSCode or Claude Desktop) to launch the server with the node command and supply your Keyshade API key via the KEYSHADE_API_KEY environment variable. Once running, the MCP server will accept requests from the client, perform Keyshade-related operations (e.g., key management or other API interactions exposed by the build), and respond back through the MCP protocol. Ensure you point the args to the correct absolute path to the built index.js file for your workspace.

Prerequisites:

• Node.js (LTS version) and pnpm installed on your system
• Git to clone the repository

Installation steps:

1. Clone the repository: git clone https://github.com/keyshade-xyz/keyshade-mcp.git cd keyshade-mcp
2. Install dependencies: pnpm install
3. Build the project: pnpm build
4. Start the server (example): node build/index.js

Notes:

• Ensure you replace YOUR_ABSOLUTE_PATH_TO/build/index.js with the actual absolute path to your built index.js when configuring MCP clients.
• You will need a Keyshade API key to authenticate requests; keep it secret and set it in the environment variable KEYSHADE_API_KEY.

Tips and common issues:

• Environment variables: KEYSHADE_API_KEY is required for authentication. Do not commit this key; keep it in your environment or secure config.
• Path correctness: The MCP client expects an absolute or workspace-root-relative path to build/index.js. Incorrect paths will cause startup failures.
• If pnpm build fails, ensure dependencies are installed correctly and your Node.js version matches project requirements.
• For debugging, check that the built index.js exports a compatible MCP server interface and that the client is configured to communicate via the stdio protocol if using the VSCode or Claude Desktop integrations.
• If you switch environments (e.g., Claude Desktop vs VSCode), ensure the mcpServers key remains consistent (same server name) and the command/args reflect your runtime (node and the built entry point).
• When regenerating builds, re-run the MCP client configuration if the index.js path changes.