Improve Apollo MCP README and VS Code setup documentation - #12
Merged
Conversation
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR substantially rewrites README.md to position the repository as the official Apollo.io MCP server, prioritize end-user installation guidance across multiple MCP clients, and document authentication, capabilities, and operational guidance (safety/privacy/troubleshooting), while retaining existing skill- and plugin-related information.
Changes:
- Reorganized the README around an “official Apollo.io MCP server” narrative with a Table of Contents and clearer prerequisites/installation flows for multiple clients (VS Code/Copilot, Cursor, Claude Code, Claude Desktop/Cowork, and generic HTTP).
- Added new sections for authentication/authorization, tool/capability inventory (as confirmed by skills), safety/privacy, troubleshooting, registry/versioning/release process, security, and support.
- Documented repository layout and the MCP Registry publishing workflow, plus added maintainer-facing TODO placeholders for unverified details.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
README.md:303
- The tool names in this table don’t match the exact identifiers used by the bundled skills (e.g., skills call
mcp__claude_ai_Apollo_MCP__apollo_mixed_people_api_search). Listing only the un-namespaced suffixes may confuse users who try to search/copy-paste tool names from the skills or client UI; please add a short note clarifying the namespacing or include the fully-qualified names.
### Underlying Apollo tools referenced by the skills
| Tool | Description | Data effect | Credits | Outreach / external action |
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
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
Rewrites the README to present this repository as the official, production-ready Apollo.io MCP server and to make installation straightforward across MCP clients. All accurate existing content is preserved; unclear sections were reorganized rather than removed.
What changed
.vscode/mcp.json,MCP: Add Server, Agent-mode auth flow), Cursor, Claude Code (remote server + plugin), Claude Desktop, Cowork, and a generic Streamable HTTP config.Accuracy notes
TODO:placeholders (see checklist below).Maintainer verification checklist
claude mcp add --transport httpcommandSECURITY.mdand confirm the private disclosure contact