@koggitechorg/koggi-mcp-server 1.0.1 → 1.0.3
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 +71 -1
- package/dist/index.js +1 -0
- package/package.json +1 -1
- package/src/index.ts +1 -0
package/README.md
CHANGED
|
@@ -1 +1,71 @@
|
|
|
1
|
-
# mcp-
|
|
1
|
+
# koggi-mcp-server
|
|
2
|
+
|
|
3
|
+
Una herramienta (MCP server) ligera para exponer un comando/tool llamado `generateSimulator` usado para generar un simulador financiero basándose en el número de documento (id de lead) de un usuario. El servidor implementa el protocolo Model Context Protocol (MCP) y está pensado para integrarse con agentes o sistemas que hablen MCP por stdin/stdout.
|
|
4
|
+
|
|
5
|
+
## Contenido
|
|
6
|
+
|
|
7
|
+
- `src/index.ts` - Entrada principal que registra la tool `generateSimulator` y arranca el servidor MCP usando `StdioServerTransport`.
|
|
8
|
+
- `src/handlers/simulator.ts` - Handlers/implementación auxiliar del handler `generateSimulator` (versiones JS/TS).
|
|
9
|
+
- `src/utils/apiClient.ts` - Cliente HTTP usado para llamar al endpoint interno/external que calcula el simulador.
|
|
10
|
+
- `src/config/config.ts` - Carga de variables de entorno (usa `dotenv`).
|
|
11
|
+
|
|
12
|
+
## Características
|
|
13
|
+
|
|
14
|
+
- Tool MCP: `generateSimulator`
|
|
15
|
+
- Propósito: Generar un simulador financiero para un usuario dado.
|
|
16
|
+
- Schema (Zod): `id_lead`, `email_requester`, `income_updated`, `observations` (todos obligatorios en la versión TS de `index.ts`).
|
|
17
|
+
- Comunicación: stdin/stdout (StdioServerTransport) siguiendo el SDK `@modelcontextprotocol/sdk`.
|
|
18
|
+
- Cliente HTTP: usa `node-fetch` y `EXTERNAL_URL` como base para las peticiones.
|
|
19
|
+
|
|
20
|
+
## Requisitos
|
|
21
|
+
|
|
22
|
+
- Node.js 18+ (o compatible con ESM y fetch nativo).
|
|
23
|
+
- npm
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## Configuración y ejecución (ejemplos de integración)
|
|
27
|
+
|
|
28
|
+
En lugar de instrucciones de instalación local, aquí hay ejemplos prácticos para integrar el servidor en un flujo MCP o en ADK.
|
|
29
|
+
|
|
30
|
+
Ejemplo `mcp.json` (útil para ejecutar con orquestadores que esperan ese formato):
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"servers": {
|
|
35
|
+
"koggi-mcp-server": {
|
|
36
|
+
"command": "npx",
|
|
37
|
+
"args": [
|
|
38
|
+
"-y", "@koggitechorg/koggi-mcp-server"
|
|
39
|
+
],
|
|
40
|
+
"env": {
|
|
41
|
+
"EXTERNAL_URL": "https://external-qa-502142473966.us-central1.run.app"
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"inputs": []
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Ejemplo de integración en ADK (snippet Python) usando parámetros de Stdio:
|
|
50
|
+
|
|
51
|
+
```py
|
|
52
|
+
tools = [
|
|
53
|
+
MCPToolsetConParseo(
|
|
54
|
+
connection_params=StdioServerParameters(
|
|
55
|
+
command="npx",
|
|
56
|
+
args=["-y", "@koggitechorg/koggi-mcp-server"],
|
|
57
|
+
env={"EXTERNAL_URL": EXTERNAL_URL},
|
|
58
|
+
)
|
|
59
|
+
),
|
|
60
|
+
]
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Estos ejemplos muestran cómo arrancar el servidor desde `npx` (instalación bajo demanda) y pasar `EXTERNAL_URL` como variable de entorno. `EXTERNAL_URL` se concatena con las rutas internas definidas en el cliente HTTP (`src/utils/apiClient.ts`).
|
|
64
|
+
|
|
65
|
+
## Licencia
|
|
66
|
+
|
|
67
|
+
Licencia no especificada en el repo. Añade un `LICENSE` si quieres publicar bajo una licencia permissiva (MIT, Apache-2.0, etc.).
|
|
68
|
+
|
|
69
|
+
## Contacto
|
|
70
|
+
|
|
71
|
+
Si necesitas ayuda para adaptar el servidor (p. ej. cambiar transporte, añadir nuevas tools o endpoints), abre un issue o contacta al equipo de Koggitech.
|
package/dist/index.js
CHANGED
package/package.json
CHANGED
package/src/index.ts
CHANGED