@vibeprospecting/vpai 0.1.0

package/README.md

@@ -0,0 +1,164 @@
+# vpai
+
+**Vibe Prospecting** – Power your chat with B2B data to create lead lists, research companies, personalize your outreach, and more.
+
+Search any company or professional to access emails, phone numbers, roles, growth signals, tech stack details, business events, website changes, and more. Use it to find qualified leads, research prospects, create personalized outreach, or identify talent, all directly within your chat. Vibe Prospecting provides fresh and compliant B2B data through a complete enrichment hub.
+
+**Developed by:** [vibeprospecting.ai](https://vibeprospecting.ai)
+
+**MCP endpoint:** [mcp.explorium.ai/mcp](https://mcp.explorium.ai/mcp)
+
+---
+
+## Quick Start
+
+```bash
+# Install globally
+npm install -g @vibeprospecting/vpai
+
+# Authenticate (once; opens browser)
+mcporter auth vpai
+
+# Run
+vpai --help
+vpai match-business --args '{"businesses_to_match":[{"name":"Google"}]}'
+```
+
+---
+
+## Installation
+
+### From npm
+
+```bash
+npm install -g @vibeprospecting/vpai
+```
+
+### From source
+
+```bash
+git clone <repo>
+cd mcp-cli
+npm install
+npm run build
+```
+
+Produces:
+
+- `dist/vpai.js` – Bun bundle (requires Bun runtime)
+- `dist/vpai` – Standalone executable (no runtime; Linux/macOS)
+
+### Run without installing
+
+```bash
+npm run call -- <command> [options]
+# or
+bun dist/vpai.js <command> [options]
+```
+
+---
+
+## Prerequisites
+
+- [Bun](https://bun.sh) (for build) or Node.js
+- OAuth access to Explorium MCP
+
+---
+
+## Usage
+
+### Workflow
+
+1. `vpai --help` – List tools and descriptions
+2. `vpai <tool> --all-parameters` – Inspect input/output JSON schema
+3. `vpai <tool> --args '<json>'` – Execute with JSON arguments
+
+### Examples
+
+```bash
+# Resolve business IDs
+vpai match-business --args '{"businesses_to_match":[{"name":"Amazon","domain":"amazon.com"}]}'
+
+# Search businesses
+vpai fetch-businesses --args '{"country_code":{"values":["US"]},"company_size":{"values":["51-200"]}}'
+
+# Enrich a business
+vpai enrich-business --args '{"business_ids":["biz_xxx"],"enrichments":["firmographics","technographics"]}'
+
+# Get autocomplete values (required before some filters)
+vpai autocomplete --args '{"field":"linkedin_category","query":"software"}'
+```
+
+### Flags
+
+| Flag | Description |
+|------|-------------|
+| `--args '<json>'` | Tool arguments as JSON |
+| `--all-parameters` | Print input/output schema |
+| `--json` | Output schema as JSON |
+
+---
+
+## Tools
+
+| Command | Description |
+|---------|-------------|
+| `match-business` | Resolve business IDs from names/domains |
+| `fetch-businesses` | Search businesses by filters |
+| `fetch-businesses-statistics` | Aggregated business insights |
+| `fetch-businesses-events` | Business events in bulk |
+| `enrich-business` | Enrich business data |
+| `match-prospects` | Resolve prospect IDs |
+| `fetch-prospects` | Search prospects by filters |
+| `fetch-prospects-events` | Prospect events |
+| `fetch-prospects-statistics` | Aggregated prospect insights |
+| `enrich-prospects` | Enrich prospect data |
+| `autocomplete` | Get valid filter values |
+| `web-search` | Web search |
+
+---
+
+## Production
+
+### Standalone binary
+
+The compiled `dist/vpai` binary is self-contained. Deploy by copying it to the target system; no Node/Bun or config files required.
+
+```bash
+# Copy to PATH
+cp dist/vpai /usr/local/bin/vpai
+# or
+cp dist/vpai ~/bin/vpai
+```
+
+### Auth
+
+Tokens are stored by mcporter. Run `mcporter auth vpai` once per environment. For CI or headless use, configure mcporter accordingly.
+
+### Config
+
+MCP server URL, OAuth settings, and timeout are embedded in the build (`src/embedded-config.ts`). No external config files.
+
+---
+
+## Project Structure
+
+```
+mcp-cli/
+├── src/
+│   ├── cli.ts             # Entry point
+│   ├── proxy.ts           # Tool registration
+│   ├── config.ts          # Config loader
+│   ├── embedded-config.ts # MCP URL, OAuth, timeout
+│   ├── runtime.ts         # mcporter runtime
+│   ├── executors/         # Tool execution
+│   ├── output/            # Result and schema printing
+│   └── schemas/           # Schema resolution
+└── dist/                  # Build output
+```
+
+---
+
+## Dependencies
+
+- [mcporter](https://github.com/mcporter/mcporter) – MCP client with OAuth