docs: Add npm-specific README for npm package #131
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…l docs Co-Authored-By: [email protected] <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds a dedicated
npm.readme.mdfile with installation instructions tailored for the npm package (exa-mcp-server). Unlike the GitHub README which focuses on the remote MCP server, this README shows how to configure each MCP client to use the npm package with theEXA_API_KEYenvironment variable.Includes configurations for 11 MCP clients: Cursor, VS Code, Claude Code, Claude Desktop, Codex, Windsurf, Zed, Gemini CLI, Kiro, Roo Code, and a generic "Other Clients" section.
Updates since last revision
"type": "stdio"field (stdio is the default for command-based servers)claude mcp add --transport stdio --env EXA_API_KEY=... exa -- npx -y exa-mcp-serverper official docscodex mcp add --env EXA_API_KEY=... exa -- npx -y exa-mcp-server--toolsflag section: The npm package doesn't support CLI flags for tool selection; users should use the remote MCP server with?tools=parameter insteadReview & Testing Checklist for Human
claude mcp add --transport stdio --env EXA_API_KEY=your_api_key exa -- npx -y exa-mcp-serverwas derived from official docs but not tested in Claude Codecodex mcp add --env EXA_API_KEY=your_api_key exa -- npx -y exa-mcp-serverwas inferred from similar patterns but not tested"command": { "path": ..., "args": ..., "env": ... }structure which differs from other clientsREADME.mdfrom package root. Options: (a) add a prepublish script to swap READMEs, (b) manually rename before publishing, or (c) keep both and update the main README to include npm instructionsTest plan: Try configuring at least one MCP client (e.g., Claude Desktop) with the npm package config from this README and verify it connects successfully.
Notes
This file is not automatically used by npm - it's a reference that needs to be integrated into the publishing workflow.
Requested by: [email protected]
Link to Devin run: https://app.devin.ai/sessions/e43115ba2a9c42728896152690b5320c