### Install Dependencies Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Installs project dependencies using npm. Ensure Node.js 16+ is installed. ```bash npm install ``` -------------------------------- ### Start Development Server Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Starts the development server with hot reload enabled. The server will be accessible at http://localhost:3000. ```bash npm run dev ``` -------------------------------- ### Create Environment Configuration Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Copies the example environment file to .env and prompts to edit it with API keys and settings. ```bash cp env.example .env # Edit .env with your Captain Data API key and other settings ``` -------------------------------- ### Deploy to Vercel Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Steps to deploy the project using Vercel. Requires global installation of the vercel CLI and login. ```bash npm i -g vercel vercel login vercel ``` -------------------------------- ### GET /docs Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Provides access to interactive API documentation via Swagger UI. ```APIDOC ## GET /docs ### Description Provides interactive API documentation using Swagger UI. ### Method GET ### Endpoint /docs ``` -------------------------------- ### GET /openapi.gpt.json Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Retrieves the GPT-compatible OpenAPI specification. ```APIDOC ## GET /openapi.gpt.json ### Description Retrieves the GPT-compatible OpenAPI specification. ### Method GET ### Endpoint /openapi.gpt.json ``` -------------------------------- ### GET /introspect Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Lists available tools. Supports basic and full modes. ```APIDOC ## GET /introspect ### Description Lists available tools. Use `v=full` for a comprehensive list. ### Method GET ### Endpoint /introspect #### Query Parameters - **v** (string) - Optional - Use `full` to list all available tools. ``` -------------------------------- ### GET /openapi.json Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Retrieves the raw OpenAPI specification. ```APIDOC ## GET /openapi.json ### Description Retrieves the raw OpenAPI specification. ### Method GET ### Endpoint /openapi.json ``` -------------------------------- ### GET /docs/json Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Retrieves the OpenAPI specification in JSON format. ```APIDOC ## GET /docs/json ### Description Retrieves the OpenAPI specification in JSON format. ### Method GET ### Endpoint /docs/json ``` -------------------------------- ### GET /health Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Health check and system status endpoint. ```APIDOC ## GET /health ### Description Checks the health and status of the system. ### Method GET ### Endpoint /health ``` -------------------------------- ### enrich_company Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Gets comprehensive company data from LinkedIn company pages. ```APIDOC ## enrich_company ### Description Get comprehensive company data from LinkedIn company pages. ### Method POST ### Endpoint /tools/enrich_company #### Input - **li_company_url** (string) - Required - The LinkedIn company URL. ``` -------------------------------- ### Run All Tests Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Execute all tests in the project using npm test. This is the primary command for verifying the project's integrity. ```bash # Run all tests npm test ``` -------------------------------- ### Development Scripts Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md A collection of npm scripts for common development tasks including running the server, tests, type checking, building, and generating OpenAPI documentation. ```bash # Start development server with hot reload npm run dev # Run tests npm test # Run tests with coverage npm run test:coverage # Type checking npm run type-check # Build for production npm run build # Generate OpenAPI documentation npm run generate:openapi npm run generate:openapi:gpt ``` -------------------------------- ### View Application Logs on Vercel Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/DEPLOYMENT.md Command to view application logs when deployed on Vercel. ```bash # View logs (Vercel) vercel logs ``` -------------------------------- ### Custom GPT Authentication Workaround Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Demonstrates how to authenticate with the API using query parameters for Custom GPTs, as a workaround for limitations with authorization headers. For production, header-based authentication is preferred. ```http POST /tools/enrich_person?session_token=your_session_token ``` -------------------------------- ### Inspect Environment Variables Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/DEPLOYMENT.md Executes a short Node.js script to print all current environment variables. ```bash # Check environment variables node -e "console.log(process.env)" ``` -------------------------------- ### View Application Logs with PM2 Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/DEPLOYMENT.md Command to view application logs when using PM2 as a process manager. ```bash # View logs (PM2) pm2 logs captaindata-mcp ``` -------------------------------- ### Project Architecture Overview Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Provides a directory structure overview of the CaptainData MCP API project, detailing the purpose of key directories and files. ```tree src/ ├── api/ # API layer │ ├── handlers/ # Request handlers │ │ ├── auth.ts # Authentication endpoint │ │ ├── health.ts # Health check │ │ ├── introspect.ts # Tool introspection │ │ └── tools.ts # Tool execution │ ├── routes.ts # Route registration │ └── schemas/ # Request/response schemas ├── lib/ # Core business logic │ ├── alias.ts # Tool alias mappings │ ├── auth.ts # Authentication logic │ ├── config.ts # Configuration management │ ├── error.ts # Error handling utilities │ ├── redis.ts # Redis service │ ├── schemas/ # Tool parameter schemas │ ├── translate.ts # API translation layer │ └── responseSchemas.ts # Response schemas ├── middleware/ # Request middleware │ ├── logging.ts # Request logging │ └── security.ts # Security middleware ├── server/ # Server configuration │ ├── build.ts # Server builder │ └── start.ts # Development server └── scripts/ # Build scripts ├── generate-openapi.ts └── generate-openapi-gpt.ts ``` -------------------------------- ### Run Tests with Coverage Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Execute all tests and generate a code coverage report using the npm script test:coverage. This helps identify untested code sections. ```bash # Run tests with coverage npm run test:coverage ``` -------------------------------- ### POST /auth Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Generates a session token using an API key. ```APIDOC ## POST /auth ### Description Generates a session token from an API key. ### Method POST ### Endpoint /auth #### Request Body - **api_key** (string) - Required - The API key for authentication. ``` -------------------------------- ### POST /tools/:alias Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Executes a specific tool identified by its alias. ```APIDOC ## POST /tools/:alias ### Description Executes a specific tool using its alias. ### Method POST ### Endpoint /tools/:alias #### Path Parameters - **alias** (string) - Required - The alias of the tool to execute. #### Request Body - **input** (object) - Required - The input parameters for the tool. ``` -------------------------------- ### Run Specific Test Suites Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Execute specific test suites by their designated npm scripts. Useful for targeted testing during development. ```bash # Run specific test suites npm run test:health npm run test:auth npm run test:tools npm run test:integration ``` -------------------------------- ### get_quotas Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Retrieves current workspace quota and billing information. ```APIDOC ## get_quotas ### Description Get current workspace quota and billing information. ### Method POST ### Endpoint /tools/get_quotas #### Input None #### Returns - Credits remaining - Credits used - Plan name - Billing cycle dates ``` -------------------------------- ### search_people Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Finds prospects using Sales Navigator with advanced filtering. ```APIDOC ## search_people ### Description Find prospects using Sales Navigator with advanced filtering. ### Method POST ### Endpoint /tools/search_people #### Input - **query** (string) - Required - Sales Navigator query parameters. - **page** (integer) - Optional - The page number for pagination. - **page_size** (integer) - Optional - The number of results per page. ``` -------------------------------- ### search_companies Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Discovers target companies based on various criteria. ```APIDOC ## search_companies ### Description Discover target companies based on various criteria. ### Method POST ### Endpoint /tools/search_companies #### Input - **query** (string) - Required - Sales Navigator query parameters. - **page** (integer) - Optional - The page number for pagination. - **page_size** (integer) - Optional - The number of results per page. ``` -------------------------------- ### search_company_employees Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Identifies key contacts within specific organizations. ```APIDOC ## search_company_employees ### Description Identify key contacts within specific organizations. ### Method POST ### Endpoint /tools/search_company_employees #### Input - **company_uid** (string) - Required - The UID of the company. - **page** (integer) - Optional - The page number for pagination. - **page_size** (integer) - Optional - The number of results per page. ``` -------------------------------- ### find_company Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Finds a company's LinkedIn page by name. ```APIDOC ## find_company ### Description Find a company's LinkedIn page by name. ### Method POST ### Endpoint /tools/find_company #### Input - **company_name** (string) - Required - The name of the company. ``` -------------------------------- ### enrich_person Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Extracts detailed profile information from LinkedIn URLs. ```APIDOC ## enrich_person ### Description Extract detailed profile information from LinkedIn URLs. ### Method POST ### Endpoint /tools/enrich_person #### Input - **li_profile_url** (string) - Required - The LinkedIn profile URL. - **full_enrich** (boolean) - Optional - If true, performs a full enrichment. ``` -------------------------------- ### find_person Source: https://github.com/captaindatatech/captaindata-mcp/blob/main/README.md Finds a person's LinkedIn profile by name and optional company name. ```APIDOC ## find_person ### Description Find a person's LinkedIn profile by name. ### Method POST ### Endpoint /tools/find_person #### Input - **full_name** (string) - Required - The full name of the person. - **company_name** (string) - Optional - The name of the company the person works for. #### Returns - LinkedIn profile URL - UID - Profile ID ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.