Skip to content

Improve Apollo MCP README and VS Code setup documentation - #12

Merged
marcus-gomes-v merged 4 commits into
mainfrom
marcus-gomes-v/improve-mcp-readme
Jul 20, 2026
Merged

Improve Apollo MCP README and VS Code setup documentation#12
marcus-gomes-v merged 4 commits into
mainfrom
marcus-gomes-v/improve-mcp-readme

Conversation

@marcus-gomes-v

Copy link
Copy Markdown
Collaborator

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

  • Repositioned as "Apollo.io MCP Server" with a clear value proposition, official first-party wording, and a Table of Contents.
  • Reordered so user-facing installation comes first and development/registry internals come last.
  • Added client setup guides for GitHub Copilot + VS Code (.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.
  • New sections: Overview, Authentication & Authorization, Available Tools & Capabilities, Safety, Privacy, Troubleshooting, Official MCP Registry, Versioning & Releases, Security, and Support.
  • Preserved: Cowork one-click install, model recommendations, credits & safety guidance, quickstart examples, skills table, and MIT license.

Accuracy notes

  • Tools listed are only those referenced by the skills in this repo; no tools, flags, or OAuth specifics were invented.
  • Distinguishes the official Model Context Protocol Registry (where this server is published and active) from the curated GitHub MCP Registry / VS Code gallery.
  • Unconfirmed details are marked with visible TODO: placeholders (see checklist below).

Maintainer verification checklist

  • Confirm plan / permissions / credit prerequisites
  • Confirm per-tool credit costs and read/write classifications; link a canonical tool list
  • Confirm OAuth revocation steps
  • Confirm Claude Desktop connector labels
  • Confirm the claude mcp add --transport http command
  • Confirm official Apollo privacy/security URLs
  • Add SECURITY.md and confirm the private disclosure contact
  • Confirm product support and bug/feature-request channels
  • Confirm GitHub release/tag process

@orca-security-us orca-security-us Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread README.md Outdated
Comment thread README.md
marcus-gomes-v and others added 2 commits July 20, 2026 20:16
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>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread README.md Outdated
Comment thread README.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 |

@marcus-gomes-v
marcus-gomes-v merged commit e8244c1 into main Jul 20, 2026
6 checks passed
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.

2 participants