dog-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.
- package/README.md +22 -0
- package/dist/api.js +64 -0
- package/dist/index.js +4 -0
- package/dist/server.js +76 -0
- package/package.json +46 -0
- package/server.json +20 -0
package/README.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Dog MCP
|
|
2
|
+
|
|
3
|
+
Dogs in one place: breed list, random photos by breed, breed image sets, facts, and random media. No key required.
|
|
4
|
+
|
|
5
|
+
This file is self contained. It reads public data only and never writes to the machine. All output is bounded and honest about what could not be fetched.
|
|
6
|
+
|
|
7
|
+
## Tools
|
|
8
|
+
|
|
9
|
+
* `listBreeds` List all dog breeds.
|
|
10
|
+
* `randomImage` Random dog photo, optionally by breed.
|
|
11
|
+
* `breedImages` Several random photos of a breed.
|
|
12
|
+
* `facts` Random dog facts.
|
|
13
|
+
* `randomMedia` Random dog photo or video.
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install
|
|
19
|
+
npm run build
|
|
20
|
+
node dist/index.js
|
|
21
|
+
```
|
|
22
|
+
|
package/dist/api.js
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
const CEO_BASE = 'https://dog.ceo/api';
|
|
2
|
+
const DOGAPI_BASE = 'https://dogapi.dog/api/v2';
|
|
3
|
+
const RANDOM_BASE = 'https://random.dog';
|
|
4
|
+
const UA = 'mrfentmen-dog-mcp/1.0 (https://github.com/mrfentmen)';
|
|
5
|
+
export class DogError extends Error {
|
|
6
|
+
}
|
|
7
|
+
async function get(url) {
|
|
8
|
+
const res = await fetch(url, { headers: { 'User-Agent': UA, Accept: 'application/json' }, signal: AbortSignal.timeout(20000) });
|
|
9
|
+
if (res.status === 429)
|
|
10
|
+
throw new DogError('dog.ceo rate limit hit, wait and retry');
|
|
11
|
+
if (!res.ok)
|
|
12
|
+
throw new DogError(`Dog API error ${res.status}`);
|
|
13
|
+
return (await res.json());
|
|
14
|
+
}
|
|
15
|
+
export async function listBreeds(_args = {}) {
|
|
16
|
+
const d = await get(`${CEO_BASE}/breeds/list/all`);
|
|
17
|
+
const breeds = d.message ?? {};
|
|
18
|
+
const names = Object.entries(breeds)
|
|
19
|
+
.map(([breed, subs]) => (subs.length ? `${breed} (${subs.join(', ')})` : breed));
|
|
20
|
+
return `${names.length} breeds\n${names.slice(0, 60).join('\n')}`;
|
|
21
|
+
}
|
|
22
|
+
export async function randomImage(args) {
|
|
23
|
+
const breed = (args.breed ?? '').trim().toLowerCase();
|
|
24
|
+
const url = breed
|
|
25
|
+
? `${CEO_BASE}/breed/${encodeURIComponent(breed)}/images/random`
|
|
26
|
+
: `${CEO_BASE}/breeds/image/random`;
|
|
27
|
+
const d = await get(url);
|
|
28
|
+
if (d.status === 'error')
|
|
29
|
+
throw new DogError(d.message ?? `Breed "${breed}" not found`);
|
|
30
|
+
return `Random dog photo${breed ? ` (${breed})` : ''}: ${d.message ?? 'no image returned'}`;
|
|
31
|
+
}
|
|
32
|
+
export async function breedImages(args) {
|
|
33
|
+
const breed = (args.breed ?? '').trim().toLowerCase();
|
|
34
|
+
if (!breed)
|
|
35
|
+
throw new DogError('Provide a breed name');
|
|
36
|
+
const limit = Math.max(1, Math.min(args.limit ?? 3, 8));
|
|
37
|
+
const d = await get(`${CEO_BASE}/breed/${encodeURIComponent(breed)}/images/random/${limit}`);
|
|
38
|
+
if (d.status === 'error')
|
|
39
|
+
throw new DogError((d.message ?? []).join(', ') || `Breed "${breed}" not found`);
|
|
40
|
+
return `${breed} (${(d.message ?? []).length} images):\n${(d.message ?? []).join('\n')}`;
|
|
41
|
+
}
|
|
42
|
+
export async function facts(args) {
|
|
43
|
+
const n = Math.max(1, Math.min(args.limit ?? 1, 10));
|
|
44
|
+
const d = await get(`${DOGAPI_BASE}/facts?limit=${n}`);
|
|
45
|
+
const list = (d.data ?? []).map((f) => f.attributes.body).filter(Boolean);
|
|
46
|
+
if (!list.length)
|
|
47
|
+
return 'No dog facts available right now.';
|
|
48
|
+
return list.map((f, i) => `${i + 1}. ${f}`).join('\n');
|
|
49
|
+
}
|
|
50
|
+
export async function randomMedia(_args = {}) {
|
|
51
|
+
const res = await fetch(`${RANDOM_BASE}/woof.json`, {
|
|
52
|
+
headers: { 'User-Agent': UA, Accept: 'application/json' },
|
|
53
|
+
signal: AbortSignal.timeout(20000),
|
|
54
|
+
});
|
|
55
|
+
if (!res.ok)
|
|
56
|
+
throw new DogError(`random.dog returned ${res.status}`);
|
|
57
|
+
const d = (await res.json());
|
|
58
|
+
return [
|
|
59
|
+
`Random dog:`,
|
|
60
|
+
`URL: ${d.url ?? '?'}`,
|
|
61
|
+
d.fileSizeBytes ? `Size: ${(d.fileSizeBytes / 1024).toFixed(0)} KB` : null,
|
|
62
|
+
d.urlSuffix ? `Suffix: ${d.urlSuffix}` : null,
|
|
63
|
+
].filter(Boolean).join('\n');
|
|
64
|
+
}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
2
|
+
import { createServer } from "./server.js";
|
|
3
|
+
const main = async () => { const server = createServer(); await server.connect(new StdioServerTransport()); };
|
|
4
|
+
main().catch((error) => { console.error("Fatal error:", error); process.exit(1); });
|
package/dist/server.js
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
import { listBreeds, randomImage, breedImages, facts, randomMedia } from './api.js';
|
|
4
|
+
const text = (value) => ({ content: [{ type: 'text', text: value }] });
|
|
5
|
+
const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
|
|
6
|
+
const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
|
|
7
|
+
const error = (e) => `Error: ${e instanceof Error ? e.message : String(e)}`;
|
|
8
|
+
export function createServer() {
|
|
9
|
+
const server = new McpServer({ name: 'dog-mcp', version: '1.0.0' });
|
|
10
|
+
server.registerTool('listBreeds', {
|
|
11
|
+
title: "List Breeds",
|
|
12
|
+
description: 'List all dog breeds from dog.ceo.',
|
|
13
|
+
inputSchema: z.object({}),
|
|
14
|
+
annotations: READ_ONLY,
|
|
15
|
+
}, async () => {
|
|
16
|
+
try {
|
|
17
|
+
return text(await listBreeds());
|
|
18
|
+
}
|
|
19
|
+
catch (e) {
|
|
20
|
+
return textError(error(e));
|
|
21
|
+
}
|
|
22
|
+
});
|
|
23
|
+
server.registerTool('randomImage', {
|
|
24
|
+
title: "Random Image",
|
|
25
|
+
description: 'Random dog photo from dog.ceo, optionally by breed.',
|
|
26
|
+
inputSchema: z.object({ breed: z.string().describe('Optional breed name.').optional() }),
|
|
27
|
+
annotations: READ_ONLY,
|
|
28
|
+
}, async (args) => {
|
|
29
|
+
try {
|
|
30
|
+
return text(await randomImage(args));
|
|
31
|
+
}
|
|
32
|
+
catch (e) {
|
|
33
|
+
return textError(error(e));
|
|
34
|
+
}
|
|
35
|
+
});
|
|
36
|
+
server.registerTool('breedImages', {
|
|
37
|
+
title: "Breed Images",
|
|
38
|
+
description: 'Several random photos of a specific breed.',
|
|
39
|
+
inputSchema: z.object({ breed: z.string().describe('Breed name.').optional(), limit: z.number().describe('How many images.').optional() }),
|
|
40
|
+
annotations: READ_ONLY,
|
|
41
|
+
}, async (args) => {
|
|
42
|
+
try {
|
|
43
|
+
return text(await breedImages(args));
|
|
44
|
+
}
|
|
45
|
+
catch (e) {
|
|
46
|
+
return textError(error(e));
|
|
47
|
+
}
|
|
48
|
+
});
|
|
49
|
+
server.registerTool('facts', {
|
|
50
|
+
title: "Facts",
|
|
51
|
+
description: 'Random dog facts from dogapi.dog.',
|
|
52
|
+
inputSchema: z.object({ limit: z.number().describe('How many facts.').optional() }),
|
|
53
|
+
annotations: READ_ONLY,
|
|
54
|
+
}, async (args) => {
|
|
55
|
+
try {
|
|
56
|
+
return text(await facts(args));
|
|
57
|
+
}
|
|
58
|
+
catch (e) {
|
|
59
|
+
return textError(error(e));
|
|
60
|
+
}
|
|
61
|
+
});
|
|
62
|
+
server.registerTool('randomMedia', {
|
|
63
|
+
title: "Random Media",
|
|
64
|
+
description: 'Random dog photo or video from random.dog.',
|
|
65
|
+
inputSchema: z.object({}),
|
|
66
|
+
annotations: READ_ONLY,
|
|
67
|
+
}, async () => {
|
|
68
|
+
try {
|
|
69
|
+
return text(await randomMedia());
|
|
70
|
+
}
|
|
71
|
+
catch (e) {
|
|
72
|
+
return textError(error(e));
|
|
73
|
+
}
|
|
74
|
+
});
|
|
75
|
+
return server;
|
|
76
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "1.0.0",
|
|
3
|
+
"type": "module",
|
|
4
|
+
"repository": {
|
|
5
|
+
"type": "git",
|
|
6
|
+
"url": "https://github.com/mrfentmen/dog-mcp.git"
|
|
7
|
+
},
|
|
8
|
+
"bin": {
|
|
9
|
+
"dog-mcp": "./dist/index.js"
|
|
10
|
+
},
|
|
11
|
+
"main": "./dist/index.js",
|
|
12
|
+
"files": [
|
|
13
|
+
"dist",
|
|
14
|
+
"server.json",
|
|
15
|
+
"README.md"
|
|
16
|
+
],
|
|
17
|
+
"scripts": {
|
|
18
|
+
"build": "tsc -p tsconfig.json",
|
|
19
|
+
"start": "node dist/index.js",
|
|
20
|
+
"dev": "npm run build && node dist/index.js"
|
|
21
|
+
},
|
|
22
|
+
"license": "MIT",
|
|
23
|
+
"dependencies": {
|
|
24
|
+
"@modelcontextprotocol/sdk": "^1.0.4",
|
|
25
|
+
"zod": "^3.23.8"
|
|
26
|
+
},
|
|
27
|
+
"devDependencies": {
|
|
28
|
+
"@types/node": "^22.0.0",
|
|
29
|
+
"typescript": "^5.6.0"
|
|
30
|
+
},
|
|
31
|
+
"name": "dog-mcp",
|
|
32
|
+
"description": "Dogs in one place: breed list, random photos by breed, breed image sets, facts, and random media. No key required.",
|
|
33
|
+
"mcpName": "io.github.mrfentmen/dog-mcp",
|
|
34
|
+
"keywords": [
|
|
35
|
+
"mcp",
|
|
36
|
+
"dogs",
|
|
37
|
+
"dog",
|
|
38
|
+
"breeds",
|
|
39
|
+
"facts",
|
|
40
|
+
"photos",
|
|
41
|
+
"fun"
|
|
42
|
+
],
|
|
43
|
+
"engines": {
|
|
44
|
+
"node": ">=20"
|
|
45
|
+
}
|
|
46
|
+
}
|
package/server.json
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
|
|
3
|
+
"name": "io.github.mrfentmen/dog-mcp",
|
|
4
|
+
"description": "Dogs in one place: breed list, random photos by breed, breed image sets, facts, and random...",
|
|
5
|
+
"repository": {
|
|
6
|
+
"url": "https://github.com/mrfentmen/dog-mcp",
|
|
7
|
+
"source": "github"
|
|
8
|
+
},
|
|
9
|
+
"version": "1.0.0",
|
|
10
|
+
"packages": [
|
|
11
|
+
{
|
|
12
|
+
"registryType": "npm",
|
|
13
|
+
"identifier": "dog-mcp",
|
|
14
|
+
"version": "1.0.0",
|
|
15
|
+
"transport": {
|
|
16
|
+
"type": "stdio"
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
]
|
|
20
|
+
}
|