Skip to content

Commit ff02322

Browse files
docs: add badges, UTM tracking, and links section to README
- Add npm downloads, version, TypeScript, and license badges - Add UTM parameters to all validkit.com links for tracking - Add Links section with homepage, docs, GitHub, npm, and MCP links - Use vk_your_api_key placeholder for consistency - Fix docs URL to docs.validkit.com
1 parent 0ec31e9 commit ff02322

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# ValidKit MCP Server
22

3-
Email validation for AI coding assistants. Validate emails directly from Claude Code, Cursor, Windsurf, and any MCP-compatible tool.
3+
[![npm downloads](https://img.shields.io/npm/dw/@validkit/mcp-server)](https://www.npmjs.com/package/@validkit/mcp-server)
4+
[![npm version](https://img.shields.io/npm/v/@validkit/mcp-server)](https://www.npmjs.com/package/@validkit/mcp-server)
5+
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0%2B-blue)](https://www.typescriptlang.org/)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
8+
[Model Context Protocol](https://modelcontextprotocol.io/) (MCP) server for [ValidKit](https://validkit.com?utm_source=github&utm_medium=readme&utm_campaign=mcp-server) email validation. Validate emails directly from Claude Code, Cursor, Windsurf, and any MCP-compatible AI assistant -- syntax checks, MX record verification, disposable detection, and typo suggestions, all without leaving your editor.
49

510
## Setup
611

712
### Claude Code
813

914
```bash
10-
claude mcp add validkit -e VALIDKIT_API_KEY=your_key -- npx -y @validkit/mcp-server
15+
claude mcp add validkit -e VALIDKIT_API_KEY=vk_your_api_key -- npx -y @validkit/mcp-server
1116
```
1217

1318
### Cursor
@@ -66,7 +71,7 @@ Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
6671

6772
## Get Your API Key
6873

69-
Sign up for free at [validkit.com/get-started](https://validkit.com/get-started) 1,000 validations/month included.
74+
Sign up for free at [validkit.com/get-started](https://validkit.com/get-started?utm_source=github&utm_medium=readme&utm_campaign=mcp-server) -- 1,000 validations/month included.
7075

7176
## Tools
7277

@@ -107,6 +112,14 @@ Check your API usage stats — total requests, valid/invalid counts, average res
107112
VALIDKIT_API_KEY=vk_test_... npx @modelcontextprotocol/inspector npx -y @validkit/mcp-server
108113
```
109114

115+
## Links
116+
117+
- [ValidKit Homepage](https://validkit.com?utm_source=github&utm_medium=readme&utm_campaign=mcp-server)
118+
- [API Documentation](https://docs.validkit.com?utm_source=github&utm_medium=readme&utm_campaign=mcp-server)
119+
- [GitHub Repository](https://github.com/ValidKit/validkit-mcp-server)
120+
- [npm Package](https://www.npmjs.com/package/@validkit/mcp-server)
121+
- [MCP Protocol](https://modelcontextprotocol.io/)
122+
110123
## License
111124

112125
MIT

0 commit comments

Comments
 (0)