socialcrawl-mcp 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +135 -0
  3. package/dist/__tests__/client.test.d.ts +1 -0
  4. package/dist/__tests__/client.test.js +72 -0
  5. package/dist/__tests__/client.test.js.map +1 -0
  6. package/dist/__tests__/data-integrity.test.d.ts +1 -0
  7. package/dist/__tests__/data-integrity.test.js +107 -0
  8. package/dist/__tests__/data-integrity.test.js.map +1 -0
  9. package/dist/__tests__/preflight.test.d.ts +1 -0
  10. package/dist/__tests__/preflight.test.js +28 -0
  11. package/dist/__tests__/preflight.test.js.map +1 -0
  12. package/dist/__tests__/truncation.test.d.ts +1 -0
  13. package/dist/__tests__/truncation.test.js +36 -0
  14. package/dist/__tests__/truncation.test.js.map +1 -0
  15. package/dist/client.d.ts +7 -0
  16. package/dist/client.js +86 -0
  17. package/dist/client.js.map +1 -0
  18. package/dist/constants.d.ts +5 -0
  19. package/dist/constants.js +10 -0
  20. package/dist/constants.js.map +1 -0
  21. package/dist/data/docs.d.ts +3 -0
  22. package/dist/data/docs.js +2621 -0
  23. package/dist/data/docs.js.map +1 -0
  24. package/dist/data/endpoints.d.ts +4 -0
  25. package/dist/data/endpoints.js +1385 -0
  26. package/dist/data/endpoints.js.map +1 -0
  27. package/dist/data/platforms.d.ts +4 -0
  28. package/dist/data/platforms.js +135 -0
  29. package/dist/data/platforms.js.map +1 -0
  30. package/dist/index.d.ts +2 -0
  31. package/dist/index.js +82 -0
  32. package/dist/index.js.map +1 -0
  33. package/dist/schemas/tools.d.ts +29 -0
  34. package/dist/schemas/tools.js +30 -0
  35. package/dist/schemas/tools.js.map +1 -0
  36. package/dist/tools/get-docs.d.ts +1 -0
  37. package/dist/tools/get-docs.js +19 -0
  38. package/dist/tools/get-docs.js.map +1 -0
  39. package/dist/tools/list-endpoints.d.ts +1 -0
  40. package/dist/tools/list-endpoints.js +40 -0
  41. package/dist/tools/list-endpoints.js.map +1 -0
  42. package/dist/tools/list-platforms.d.ts +1 -0
  43. package/dist/tools/list-platforms.js +17 -0
  44. package/dist/tools/list-platforms.js.map +1 -0
  45. package/dist/tools/request.d.ts +7 -0
  46. package/dist/tools/request.js +43 -0
  47. package/dist/tools/request.js.map +1 -0
  48. package/dist/types.d.ts +45 -0
  49. package/dist/types.js +2 -0
  50. package/dist/types.js.map +1 -0
  51. package/package.json +55 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Ridio Company
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,135 @@
1
+ # socialcrawl-mcp
2
+
3
+ [![npm version](https://img.shields.io/npm/v/socialcrawl-mcp.svg)](https://www.npmjs.com/package/socialcrawl-mcp)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ MCP server for SocialCrawl — access 21+ social media platforms through one unified API.
7
+
8
+ ## What it does
9
+
10
+ SocialCrawl MCP gives AI agents instant access to 21 social media platforms and 105 endpoints through a single, unified API. Retrieve profiles, posts, comments, search results, trending content, and analytics from TikTok, Instagram, YouTube, Twitter/X, LinkedIn, Reddit, and more — no per-platform authentication required. Agents discover available endpoints dynamically, so they always work with the latest capabilities without any hardcoded platform logic.
11
+
12
+ ## Quick Setup
13
+
14
+ ### Claude Desktop
15
+
16
+ Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
17
+
18
+ ```json
19
+ {
20
+ "mcpServers": {
21
+ "socialcrawl": {
22
+ "command": "npx",
23
+ "args": ["-y", "socialcrawl-mcp"],
24
+ "env": {
25
+ "SOCIALCRAWL_API_KEY": "your_api_key_here"
26
+ }
27
+ }
28
+ }
29
+ }
30
+ ```
31
+
32
+ ### Cursor
33
+
34
+ Add to `.cursor/mcp.json` in your project root or `~/.cursor/mcp.json` globally:
35
+
36
+ ```json
37
+ {
38
+ "mcpServers": {
39
+ "socialcrawl": {
40
+ "command": "npx",
41
+ "args": ["-y", "socialcrawl-mcp"],
42
+ "env": {
43
+ "SOCIALCRAWL_API_KEY": "your_api_key_here"
44
+ }
45
+ }
46
+ }
47
+ }
48
+ ```
49
+
50
+ ### VS Code (Claude Code)
51
+
52
+ Add to `.vscode/mcp.json` in your project or your user settings:
53
+
54
+ ```json
55
+ {
56
+ "servers": {
57
+ "socialcrawl": {
58
+ "type": "stdio",
59
+ "command": "npx",
60
+ "args": ["-y", "socialcrawl-mcp"],
61
+ "env": {
62
+ "SOCIALCRAWL_API_KEY": "your_api_key_here"
63
+ }
64
+ }
65
+ }
66
+ }
67
+ ```
68
+
69
+ ## Get Your API Key
70
+
71
+ 1. Sign up at [socialcrawl.com](https://socialcrawl.com) — no credit card required
72
+ 2. Receive 100 free credits instantly upon registration
73
+ 3. Copy your API key from the dashboard and paste it into your config
74
+
75
+ ## Available Tools
76
+
77
+ | Tool | Description |
78
+ |------|-------------|
79
+ | `socialcrawl_list_platforms` | Discover all 21 supported platforms with their slugs and endpoint counts |
80
+ | `socialcrawl_list_endpoints` | See all endpoints, required parameters, and credit costs for a specific platform |
81
+ | `socialcrawl_request` | Make any SocialCrawl API call — fetch profiles, posts, comments, search results, and more |
82
+ | `socialcrawl_get_docs` | Access detailed API documentation for a platform or specific endpoint |
83
+
84
+ ## Example
85
+
86
+ **User prompt:** "Get the TikTok profile for charlidamelio"
87
+
88
+ **Agent flow:**
89
+
90
+ 1. Calls `socialcrawl_list_endpoints` with `platform: "tiktok"` to discover available endpoints
91
+ 2. Finds `user/info` endpoint — takes a `username` parameter, costs 1 credit
92
+ 3. Calls `socialcrawl_request` with `platform: "tiktok"`, `endpoint: "user/info"`, `params: { username: "charlidamelio" }`
93
+ 4. Returns profile data: follower count, bio, video count, verification status, and more
94
+
95
+ ## Supported Platforms
96
+
97
+ | Platform | Endpoints |
98
+ |----------|-----------|
99
+ | TikTok | 24 |
100
+ | Instagram | 12 |
101
+ | YouTube | 11 |
102
+ | Facebook | 12 |
103
+ | X (Twitter) | 6 |
104
+ | LinkedIn | 6 |
105
+ | Reddit | 7 |
106
+ | Threads | 5 |
107
+ | Pinterest | 4 |
108
+ | Google | 4 |
109
+ | Truth Social | 3 |
110
+ | Twitch | 2 |
111
+ | Snapchat | 1 |
112
+ | Kick | 1 |
113
+ | Amazon | 1 |
114
+ | Linktree | 1 |
115
+ | Linkbio | 1 |
116
+ | Linkme | 1 |
117
+ | Komi | 1 |
118
+ | Pillar | 1 |
119
+ | Utility | 1 |
120
+
121
+ **Total: 105 endpoints across 21 platforms**
122
+
123
+ ## Credit System
124
+
125
+ | Tier | Cost | Share of Endpoints |
126
+ |------|------|--------------------|
127
+ | Standard | 1 credit | ~90% |
128
+ | Advanced | 5 credits | ~8% |
129
+ | Premium | 10 credits | ~2% |
130
+
131
+ New accounts receive 100 free credits — enough to make 100 standard requests or explore multiple platforms before committing to a paid plan.
132
+
133
+ ## License
134
+
135
+ MIT — see [LICENSE](LICENSE) for details.
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,72 @@
1
+ import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
2
+ import { makeRequest } from "../client.js";
3
+ describe("API client", () => {
4
+ const originalEnv = process.env;
5
+ beforeEach(() => {
6
+ process.env = { ...originalEnv, SOCIALCRAWL_API_KEY: "sc_test_key" };
7
+ });
8
+ afterEach(() => {
9
+ process.env = originalEnv;
10
+ vi.restoreAllMocks();
11
+ });
12
+ it("returns error when API key is empty", async () => {
13
+ process.env.SOCIALCRAWL_API_KEY = "";
14
+ const result = await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "test" } });
15
+ expect(result).toContain("No API key configured");
16
+ expect(result).toContain("SOCIALCRAWL_API_KEY");
17
+ });
18
+ it("returns error when API key is not set", async () => {
19
+ delete process.env.SOCIALCRAWL_API_KEY;
20
+ const result = await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "test" } });
21
+ expect(result).toContain("No API key configured");
22
+ });
23
+ it("builds correct URL with params", async () => {
24
+ let capturedUrl = "";
25
+ vi.stubGlobal("fetch", async (url) => {
26
+ capturedUrl = url;
27
+ return new Response(JSON.stringify({ success: true, data: {} }), { status: 200 });
28
+ });
29
+ await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "charlidamelio" } });
30
+ expect(capturedUrl).toContain("/v1/tiktok/profile");
31
+ expect(capturedUrl).toContain("handle=charlidamelio");
32
+ });
33
+ it("builds correct URL without params", async () => {
34
+ let capturedUrl = "";
35
+ vi.stubGlobal("fetch", async (url) => {
36
+ capturedUrl = url;
37
+ return new Response(JSON.stringify({ success: true, data: {} }), { status: 200 });
38
+ });
39
+ await makeRequest({ platform: "tiktok", resource: "songs/popular" });
40
+ expect(capturedUrl).toContain("/v1/tiktok/songs/popular");
41
+ expect(capturedUrl).not.toContain("?");
42
+ });
43
+ it("maps 401 to invalid API key message", async () => {
44
+ vi.stubGlobal("fetch", async () => new Response(JSON.stringify({ success: false, error: { type: "INVALID_API_KEY", message: "Invalid key" } }), { status: 401 }));
45
+ const result = await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "test" } });
46
+ expect(result).toContain("Invalid API key");
47
+ });
48
+ it("maps 402 to insufficient credits message", async () => {
49
+ vi.stubGlobal("fetch", async () => new Response(JSON.stringify({ success: false, error: { type: "INSUFFICIENT_CREDITS", message: "No credits" }, credits_remaining: 0 }), { status: 402 }));
50
+ const result = await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "test" } });
51
+ expect(result).toContain("Insufficient credits");
52
+ expect(result).toContain("socialcrawl.com/billing");
53
+ });
54
+ it("maps 404 to endpoint not found message", async () => {
55
+ vi.stubGlobal("fetch", async () => new Response(JSON.stringify({ success: false, error: { type: "ENDPOINT_NOT_FOUND" } }), { status: 404 }));
56
+ const result = await makeRequest({ platform: "tiktok", resource: "fake", params: {} });
57
+ expect(result).toContain("not found");
58
+ expect(result).toContain("socialcrawl_list_endpoints");
59
+ });
60
+ it("maps 503 to platform unavailable message", async () => {
61
+ vi.stubGlobal("fetch", async () => new Response(JSON.stringify({ success: false, error: { type: "PLATFORM_UNAVAILABLE" } }), { status: 503 }));
62
+ const result = await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "test" } });
63
+ expect(result).toContain("temporarily unavailable");
64
+ });
65
+ it("maps 502 to upstream error with refund note", async () => {
66
+ vi.stubGlobal("fetch", async () => new Response(JSON.stringify({ success: false, error: { type: "UPSTREAM_ERROR" } }), { status: 502 }));
67
+ const result = await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "test" } });
68
+ expect(result).toContain("Upstream error");
69
+ expect(result).toContain("auto-refunded");
70
+ });
71
+ });
72
+ //# sourceMappingURL=client.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.test.js","sourceRoot":"","sources":["../../src/__tests__/client.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAEhC,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,WAAW,EAAE,mBAAmB,EAAE,aAAa,EAAE,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC;QAC1B,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE;YAC3C,WAAW,GAAG,GAAG,CAAC;YAClB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,CAAC,CAAC;QACpG,MAAM,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QACpD,MAAM,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE;YAC3C,WAAW,GAAG,GAAG,CAAC;YAClB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAC;QACrE,MAAM,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QAC1D,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAChC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,aAAa,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAC9H,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAChC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CACxJ,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QACjD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACtD,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAChC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CACzG,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;QACvF,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAChC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAC3G,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAChC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CACrG,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,107 @@
1
+ import { describe, it, expect } from "vitest";
2
+ import { PLATFORMS, findPlatform, getAllPlatformSlugs } from "../data/platforms.js";
3
+ import { ENDPOINTS, findEndpoint, getEndpointsByPlatform } from "../data/endpoints.js";
4
+ import { getDoc, getAvailableTopics } from "../data/docs.js";
5
+ describe("Platform data integrity", () => {
6
+ it("has exactly 21 platforms", () => {
7
+ expect(PLATFORMS).toHaveLength(21);
8
+ });
9
+ it("every platform has a non-empty slug, name, and description", () => {
10
+ for (const platform of PLATFORMS) {
11
+ expect(platform.slug).toBeTruthy();
12
+ expect(platform.name).toBeTruthy();
13
+ expect(platform.description).toBeTruthy();
14
+ expect(platform.endpointCount).toBeGreaterThan(0);
15
+ }
16
+ });
17
+ it("has no duplicate platform slugs", () => {
18
+ const slugs = PLATFORMS.map((p) => p.slug);
19
+ expect(new Set(slugs).size).toBe(slugs.length);
20
+ });
21
+ it("findPlatform returns correct platform", () => {
22
+ const tiktok = findPlatform("tiktok");
23
+ expect(tiktok).toBeDefined();
24
+ expect(tiktok.name).toBe("TikTok");
25
+ });
26
+ it("findPlatform returns undefined for unknown slug", () => {
27
+ expect(findPlatform("nonexistent")).toBeUndefined();
28
+ });
29
+ it("getAllPlatformSlugs returns 21 slugs", () => {
30
+ expect(getAllPlatformSlugs()).toHaveLength(21);
31
+ });
32
+ });
33
+ describe("Endpoint data integrity", () => {
34
+ it("has at least 100 endpoints", () => {
35
+ expect(ENDPOINTS.length).toBeGreaterThanOrEqual(100);
36
+ });
37
+ it("every endpoint has required fields", () => {
38
+ for (const endpoint of ENDPOINTS) {
39
+ expect(endpoint.platform).toBeTruthy();
40
+ expect(endpoint.resource).toBeTruthy();
41
+ expect(endpoint.method).toBe("GET");
42
+ expect(["standard", "advanced", "premium"]).toContain(endpoint.creditTier);
43
+ expect([1, 5, 10]).toContain(endpoint.creditCost);
44
+ expect(endpoint.archetype).toBeTruthy();
45
+ expect(endpoint.summary).toBeTruthy();
46
+ }
47
+ });
48
+ it("creditCost matches creditTier", () => {
49
+ const tierCosts = { standard: 1, advanced: 5, premium: 10 };
50
+ for (const endpoint of ENDPOINTS) {
51
+ expect(endpoint.creditCost).toBe(tierCosts[endpoint.creditTier]);
52
+ }
53
+ });
54
+ it("every endpoint belongs to a known platform", () => {
55
+ const slugs = new Set(getAllPlatformSlugs());
56
+ for (const endpoint of ENDPOINTS) {
57
+ expect(slugs.has(endpoint.platform)).toBe(true);
58
+ }
59
+ });
60
+ it("every platform has endpoints matching its declared count", () => {
61
+ for (const platform of PLATFORMS) {
62
+ const endpoints = getEndpointsByPlatform(platform.slug);
63
+ expect(endpoints.length).toBe(platform.endpointCount);
64
+ }
65
+ });
66
+ it("every param has name, description, and example", () => {
67
+ for (const endpoint of ENDPOINTS) {
68
+ for (const param of endpoint.params) {
69
+ expect(param.name).toBeTruthy();
70
+ expect(param.description).toBeTruthy();
71
+ expect(param.example).toBeTruthy();
72
+ }
73
+ }
74
+ });
75
+ it("findEndpoint returns correct endpoint", () => {
76
+ const ep = findEndpoint("tiktok", "profile");
77
+ expect(ep).toBeDefined();
78
+ expect(ep.archetype).toBe("Author");
79
+ expect(ep.params.length).toBeGreaterThan(0);
80
+ expect(ep.params[0].name).toBe("handle");
81
+ });
82
+ it("findEndpoint returns undefined for unknown resource", () => {
83
+ expect(findEndpoint("tiktok", "nonexistent")).toBeUndefined();
84
+ });
85
+ });
86
+ describe("Documentation data integrity", () => {
87
+ it("has overview, full, authentication, credits, and errors topics", () => {
88
+ expect(getDoc("overview")).toBeTruthy();
89
+ expect(getDoc("full")).toBeTruthy();
90
+ expect(getDoc("authentication")).toBeTruthy();
91
+ expect(getDoc("credits")).toBeTruthy();
92
+ expect(getDoc("errors")).toBeTruthy();
93
+ });
94
+ it("has documentation for every platform", () => {
95
+ for (const platform of PLATFORMS) {
96
+ const doc = getDoc(platform.slug);
97
+ expect(doc, `Missing docs for platform: ${platform.slug}`).toBeTruthy();
98
+ }
99
+ });
100
+ it("getDoc returns undefined for unknown topic", () => {
101
+ expect(getDoc("nonexistent")).toBeUndefined();
102
+ });
103
+ it("getAvailableTopics returns at least 26 topics", () => {
104
+ expect(getAvailableTopics().length).toBeGreaterThanOrEqual(26);
105
+ });
106
+ });
107
+ //# sourceMappingURL=data-integrity.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"data-integrity.test.js","sourceRoot":"","sources":["../../src/__tests__/data-integrity.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAQ,MAAM,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEnE,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;YACnC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;YACnC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;YAC1C,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;YACvC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;YACvC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC3E,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAClD,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;QACxC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,SAAS,GAA2B,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QACpF,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,mBAAmB,EAAE,CAAC,CAAC;QAC7C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,SAAS,GAAG,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxD,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACxD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACpC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;gBAChC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;gBACvC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,EAAE,GAAG,YAAY,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC7C,MAAM,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QACzB,MAAM,CAAC,EAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,CAAC,EAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,EAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClC,MAAM,CAAC,GAAG,EAAE,8BAA8B,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QAC1E,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,CAAC,kBAAkB,EAAE,CAAC,MAAM,CAAC,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,28 @@
1
+ import { describe, it, expect } from "vitest";
2
+ import { request } from "../tools/request.js";
3
+ describe("Pre-flight validation", () => {
4
+ it("rejects unknown platform", async () => {
5
+ const result = await request({ platform: "fakebook", resource: "profile" });
6
+ expect(result).toContain("Unknown platform");
7
+ expect(result).toContain("socialcrawl_list_platforms");
8
+ });
9
+ it("rejects unknown resource for valid platform", async () => {
10
+ const result = await request({ platform: "tiktok", resource: "nonexistent" });
11
+ expect(result).toContain("Unknown resource");
12
+ expect(result).toContain("socialcrawl_list_endpoints");
13
+ });
14
+ it("rejects missing required params", async () => {
15
+ const result = await request({ platform: "tiktok", resource: "profile", params: {} });
16
+ expect(result).toContain("Missing required parameter");
17
+ expect(result).toContain("handle");
18
+ });
19
+ it("rejects when no params provided but endpoint requires them", async () => {
20
+ const result = await request({ platform: "tiktok", resource: "profile" });
21
+ expect(result).toContain("Missing required parameter");
22
+ });
23
+ it("passes validation for endpoints with no required params", async () => {
24
+ const result = await request({ platform: "tiktok", resource: "songs/popular" });
25
+ expect(result).toContain("No API key configured");
26
+ });
27
+ });
28
+ //# sourceMappingURL=preflight.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"preflight.test.js","sourceRoot":"","sources":["../../src/__tests__/preflight.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QAC5E,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;QAC9E,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;QACtF,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;QACvD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QAC1E,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAC;QAChF,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,36 @@
1
+ import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
2
+ import { makeRequest } from "../client.js";
3
+ import { CHARACTER_LIMIT } from "../constants.js";
4
+ describe("Response truncation", () => {
5
+ const originalEnv = process.env;
6
+ beforeEach(() => {
7
+ process.env = { ...originalEnv, SOCIALCRAWL_API_KEY: "sc_test_key" };
8
+ });
9
+ afterEach(() => {
10
+ process.env = originalEnv;
11
+ vi.restoreAllMocks();
12
+ });
13
+ it("does not truncate responses under the limit", async () => {
14
+ const shortBody = JSON.stringify({ success: true, data: "short" });
15
+ vi.stubGlobal("fetch", async () => new Response(shortBody, { status: 200 }));
16
+ const result = await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "test" } });
17
+ expect(result).toBe(shortBody);
18
+ expect(result).not.toContain("truncated");
19
+ });
20
+ it("truncates responses over the character limit", async () => {
21
+ const longBody = "x".repeat(CHARACTER_LIMIT + 1000);
22
+ vi.stubGlobal("fetch", async () => new Response(longBody, { status: 200 }));
23
+ const result = await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "test" } });
24
+ expect(result).toContain("truncated");
25
+ expect(result).toContain(CHARACTER_LIMIT.toLocaleString());
26
+ expect(result.length).toBeLessThan(longBody.length);
27
+ });
28
+ it("reports full response length when truncating", async () => {
29
+ const fullLength = CHARACTER_LIMIT + 5000;
30
+ const longBody = "x".repeat(fullLength);
31
+ vi.stubGlobal("fetch", async () => new Response(longBody, { status: 200 }));
32
+ const result = await makeRequest({ platform: "tiktok", resource: "profile", params: { handle: "test" } });
33
+ expect(result).toContain(fullLength.toLocaleString());
34
+ });
35
+ });
36
+ //# sourceMappingURL=truncation.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"truncation.test.js","sourceRoot":"","sources":["../../src/__tests__/truncation.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAEhC,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,WAAW,EAAE,mBAAmB,EAAE,aAAa,EAAE,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC;QAC1B,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACnE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,QAAQ,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAE7E,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC;QACpD,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,QAAQ,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAE5E,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,cAAc,EAAE,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,UAAU,GAAG,eAAe,GAAG,IAAI,CAAC;QAC1C,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACxC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,QAAQ,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAE5E,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,7 @@
1
+ interface RequestOptions {
2
+ platform: string;
3
+ resource: string;
4
+ params?: Record<string, string>;
5
+ }
6
+ export declare function makeRequest(options: RequestOptions): Promise<string>;
7
+ export {};
package/dist/client.js ADDED
@@ -0,0 +1,86 @@
1
+ import { TIMEOUT_MS, CHARACTER_LIMIT } from "./constants.js";
2
+ function getBaseUrl() {
3
+ return process.env.SOCIALCRAWL_BASE_URL ?? "https://api.socialcrawl.com";
4
+ }
5
+ function getApiKey() {
6
+ return process.env.SOCIALCRAWL_API_KEY ?? "";
7
+ }
8
+ export async function makeRequest(options) {
9
+ const apiKey = getApiKey();
10
+ if (!apiKey) {
11
+ return "Error: No API key configured. Set SOCIALCRAWL_API_KEY in your MCP server environment. Get a free key at socialcrawl.com (100 credits, no credit card required).";
12
+ }
13
+ const url = buildUrl(options);
14
+ const controller = new AbortController();
15
+ const timeoutId = setTimeout(() => controller.abort(), TIMEOUT_MS);
16
+ try {
17
+ const response = await fetch(url, {
18
+ method: "GET",
19
+ headers: {
20
+ "x-api-key": apiKey,
21
+ },
22
+ signal: controller.signal,
23
+ });
24
+ const body = await response.text();
25
+ if (!response.ok) {
26
+ return formatHttpError(response.status, body, options);
27
+ }
28
+ return truncateResponse(body);
29
+ }
30
+ catch (error) {
31
+ if (error instanceof DOMException && error.name === "AbortError") {
32
+ return `Error: Request timed out after ${TIMEOUT_MS / 1000} seconds. The platform may be experiencing delays.`;
33
+ }
34
+ if (error instanceof TypeError && (error.message.includes("fetch") || error.message.includes("network"))) {
35
+ return `Error: Could not reach SocialCrawl API at ${getBaseUrl()}. Check your network connection.`;
36
+ }
37
+ return `Error: Unexpected error — ${error instanceof Error ? error.message : String(error)}`;
38
+ }
39
+ finally {
40
+ clearTimeout(timeoutId);
41
+ }
42
+ }
43
+ function buildUrl(options) {
44
+ const base = `${getBaseUrl()}/v1/${options.platform}/${options.resource}`;
45
+ if (!options.params || Object.keys(options.params).length === 0) {
46
+ return base;
47
+ }
48
+ const searchParams = new URLSearchParams(options.params);
49
+ return `${base}?${searchParams.toString()}`;
50
+ }
51
+ function formatHttpError(status, body, options) {
52
+ let parsed = null;
53
+ try {
54
+ parsed = JSON.parse(body);
55
+ }
56
+ catch {
57
+ // body is not JSON, use raw text
58
+ }
59
+ const errorType = parsed?.error?.type ?? "UNKNOWN_ERROR";
60
+ const errorMessage = parsed?.error?.message ?? body;
61
+ switch (status) {
62
+ case 401:
63
+ return "Error: Invalid API key. Check your SOCIALCRAWL_API_KEY configuration.";
64
+ case 402:
65
+ return `Error: Insufficient credits (${parsed?.credits_remaining ?? 0} remaining). Top up at socialcrawl.com/billing.`;
66
+ case 400:
67
+ return `Error: ${errorMessage}`;
68
+ case 404:
69
+ return `Error: Endpoint /v1/${options.platform}/${options.resource} not found. Use socialcrawl_list_endpoints to see available endpoints for ${options.platform}.`;
70
+ case 503:
71
+ return `Error: Platform ${options.platform} is temporarily unavailable. Try again shortly.`;
72
+ case 502:
73
+ return "Error: Upstream error fetching data. Credits have been auto-refunded.";
74
+ case 429:
75
+ return "Error: Too many concurrent requests. Wait a moment and try again.";
76
+ default:
77
+ return `Error (${status}): ${errorType} — ${errorMessage}`;
78
+ }
79
+ }
80
+ function truncateResponse(body) {
81
+ if (body.length <= CHARACTER_LIMIT) {
82
+ return body;
83
+ }
84
+ return `${body.slice(0, CHARACTER_LIMIT)}\n\n[Response truncated at ${CHARACTER_LIMIT.toLocaleString()} characters. Full response was ${body.length.toLocaleString()} characters.]`;
85
+ }
86
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE7D,SAAS,UAAU;IACjB,OAAO,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,6BAA6B,CAAC;AAC3E,CAAC;AAED,SAAS,SAAS;IAChB,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,EAAE,CAAC;AAC/C,CAAC;AAQD,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAuB;IACvD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,iKAAiK,CAAC;IAC3K,CAAC;IAED,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC9B,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,UAAU,CAAC,CAAC;IAEnE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,WAAW,EAAE,MAAM;aACpB;YACD,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,eAAe,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,IAAI,KAAK,YAAY,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACjE,OAAO,kCAAkC,UAAU,GAAG,IAAI,oDAAoD,CAAC;QACjH,CAAC;QACD,IAAI,KAAK,YAAY,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YACzG,OAAO,6CAA6C,UAAU,EAAE,kCAAkC,CAAC;QACrG,CAAC;QACD,OAAO,6BAA6B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAC/F,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,OAAuB;IACvC,MAAM,IAAI,GAAG,GAAG,UAAU,EAAE,OAAO,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC1E,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzD,OAAO,GAAG,IAAI,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC9C,CAAC;AAOD,SAAS,eAAe,CAAC,MAAc,EAAE,IAAY,EAAE,OAAuB;IAC5E,IAAI,MAAM,GAAuB,IAAI,CAAC;IACtC,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAgB,CAAC;IAC3C,CAAC;IAAC,MAAM,CAAC;QACP,iCAAiC;IACnC,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,EAAE,KAAK,EAAE,IAAI,IAAI,eAAe,CAAC;IACzD,MAAM,YAAY,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC;IAEpD,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,GAAG;YACN,OAAO,uEAAuE,CAAC;QACjF,KAAK,GAAG;YACN,OAAO,gCAAgC,MAAM,EAAE,iBAAiB,IAAI,CAAC,iDAAiD,CAAC;QACzH,KAAK,GAAG;YACN,OAAO,UAAU,YAAY,EAAE,CAAC;QAClC,KAAK,GAAG;YACN,OAAO,uBAAuB,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,6EAA6E,OAAO,CAAC,QAAQ,GAAG,CAAC;QACrK,KAAK,GAAG;YACN,OAAO,mBAAmB,OAAO,CAAC,QAAQ,iDAAiD,CAAC;QAC9F,KAAK,GAAG;YACN,OAAO,uEAAuE,CAAC;QACjF,KAAK,GAAG;YACN,OAAO,mEAAmE,CAAC;QAC7E;YACE,OAAO,UAAU,MAAM,MAAM,SAAS,MAAM,YAAY,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAY;IACpC,IAAI,IAAI,CAAC,MAAM,IAAI,eAAe,EAAE,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,8BAA8B,eAAe,CAAC,cAAc,EAAE,kCAAkC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC;AACtL,CAAC"}
@@ -0,0 +1,5 @@
1
+ export declare const CHARACTER_LIMIT = 25000;
2
+ export declare const TIMEOUT_MS = 30000;
3
+ export declare const CREDIT_COSTS: Record<string, number>;
4
+ export declare const SERVER_NAME = "socialcrawl-mcp";
5
+ export declare const SERVER_VERSION = "1.0.0";
@@ -0,0 +1,10 @@
1
+ export const CHARACTER_LIMIT = 25_000;
2
+ export const TIMEOUT_MS = 30_000;
3
+ export const CREDIT_COSTS = {
4
+ standard: 1,
5
+ advanced: 5,
6
+ premium: 10,
7
+ };
8
+ export const SERVER_NAME = "socialcrawl-mcp";
9
+ export const SERVER_VERSION = "1.0.0";
10
+ //# sourceMappingURL=constants.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;AACtC,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC;AAEjC,MAAM,CAAC,MAAM,YAAY,GAA2B;IAClD,QAAQ,EAAE,CAAC;IACX,QAAQ,EAAE,CAAC;IACX,OAAO,EAAE,EAAE;CACH,CAAC;AAEX,MAAM,CAAC,MAAM,WAAW,GAAG,iBAAiB,CAAC;AAC7C,MAAM,CAAC,MAAM,cAAc,GAAG,OAAO,CAAC"}
@@ -0,0 +1,3 @@
1
+ export declare const DOCS: Record<string, string>;
2
+ export declare function getDoc(topic: string): string | undefined;
3
+ export declare function getAvailableTopics(): string[];