From 7b6478d8574e2e0709826fdda1bf95e8438df87a Mon Sep 17 00:00:00 2001 From: Charlie Hopkins-Brinicombe Date: Mon, 3 Aug 2026 11:06:37 +0100 Subject: [PATCH 1/4] Add mcp docs --- docs.json | 58 ++++ es/getting-started/quickstart.mdx | 346 ++++++++------------- es/mcp/account-mcp-server/capabilities.mdx | 107 +++++++ es/mcp/account-mcp-server/installation.mdx | 165 ++++++++++ es/mcp/account-mcp-server/introduction.mdx | 56 ++++ es/mcp/best-practice.mdx | 65 ++++ es/mcp/docs-mcp-server/capabilities.mdx | 91 ++++++ es/mcp/docs-mcp-server/installation.mdx | 111 +++++++ es/mcp/docs-mcp-server/introduction.mdx | 54 ++++ es/mcp/overview.mdx | 45 +++ getting-started/quickstart.mdx | 322 ++++++++----------- i18n.json | 5 +- i18n.lock | 326 +++++++++++++++---- icons/mcp.svg | 6 + mcp/account-mcp-server/capabilities.mdx | 107 +++++++ mcp/account-mcp-server/installation.mdx | 162 ++++++++++ mcp/account-mcp-server/introduction.mdx | 55 ++++ mcp/best-practice.mdx | 65 ++++ mcp/docs-mcp-server/capabilities.mdx | 91 ++++++ mcp/docs-mcp-server/installation.mdx | 109 +++++++ mcp/docs-mcp-server/introduction.mdx | 51 +++ mcp/overview.mdx | 45 +++ style.css | 16 + 23 files changed, 1991 insertions(+), 467 deletions(-) create mode 100644 es/mcp/account-mcp-server/capabilities.mdx create mode 100644 es/mcp/account-mcp-server/installation.mdx create mode 100644 es/mcp/account-mcp-server/introduction.mdx create mode 100644 es/mcp/best-practice.mdx create mode 100644 es/mcp/docs-mcp-server/capabilities.mdx create mode 100644 es/mcp/docs-mcp-server/installation.mdx create mode 100644 es/mcp/docs-mcp-server/introduction.mdx create mode 100644 es/mcp/overview.mdx create mode 100644 icons/mcp.svg create mode 100644 mcp/account-mcp-server/capabilities.mdx create mode 100644 mcp/account-mcp-server/installation.mdx create mode 100644 mcp/account-mcp-server/introduction.mdx create mode 100644 mcp/best-practice.mdx create mode 100644 mcp/docs-mcp-server/capabilities.mdx create mode 100644 mcp/docs-mcp-server/installation.mdx create mode 100644 mcp/docs-mcp-server/introduction.mdx create mode 100644 mcp/overview.mdx create mode 100644 style.css diff --git a/docs.json b/docs.json index ce7dcd9a..1674147a 100644 --- a/docs.json +++ b/docs.json @@ -377,6 +377,35 @@ } ] }, + { + "tab": "MCP", + "icon": "/icons/mcp.svg", + "groups": [ + { + "group": "Getting Started", + "pages": [ + "mcp/overview", + "mcp/best-practice" + ] + }, + { + "group": "Docs MCP Server", + "pages": [ + "mcp/docs-mcp-server/introduction", + "mcp/docs-mcp-server/installation", + "mcp/docs-mcp-server/capabilities" + ] + }, + { + "group": "Account MCP Server", + "pages": [ + "mcp/account-mcp-server/introduction", + "mcp/account-mcp-server/installation", + "mcp/account-mcp-server/capabilities" + ] + } + ] + }, { "tab": "UI Kit", "icon": "shapes", @@ -734,6 +763,35 @@ } ] }, + { + "tab": "MCP", + "icon": "/icons/mcp.svg", + "groups": [ + { + "group": "Primeros pasos", + "pages": [ + "es/mcp/overview", + "es/mcp/best-practice" + ] + }, + { + "group": "Servidor MCP de docs", + "pages": [ + "es/mcp/docs-mcp-server/introduction", + "es/mcp/docs-mcp-server/installation", + "es/mcp/docs-mcp-server/capabilities" + ] + }, + { + "group": "Servidor MCP de cuenta", + "pages": [ + "es/mcp/account-mcp-server/introduction", + "es/mcp/account-mcp-server/installation", + "es/mcp/account-mcp-server/capabilities" + ] + } + ] + }, { "tab": "Kit de UI", "icon": "shapes", diff --git a/es/getting-started/quickstart.mdx b/es/getting-started/quickstart.mdx index ed66c0b8..a343513a 100644 --- a/es/getting-started/quickstart.mdx +++ b/es/getting-started/quickstart.mdx @@ -11,91 +11,110 @@ import TrophyClientInitBlock from "../../snippets/trophy-client-init-block.mdx"; import MetricChangeRequestBlock from "../../snippets/metric-change-request-block.mdx"; import MetricChangeResponseBlock from "../../snippets/metric-change-response-block.mdx"; -Aquí integrarás tu aplicación web backend con Trophy y comenzarás a construir tu primera función gamificada. +Aquí integrarás tu aplicación con Trophy y comenzarás a construir tu primera funcionalidad gamificada. - - Estas instrucciones son para quienes desean implementar Trophy manualmente. Si prefieres usar agentes de codificación, cambia de pestaña arriba. - + + Estas instrucciones son para quienes prefieren desarrollar usando agentes de codificación como Cursor y Claude Code. + - Primero, [crea una cuenta nueva](https://app.trophy.so/sign-up?utm_source=docs&utm_medium=quickstart) si aún no tienes una y accede al [panel de Trophy](https://app.trophy.so). - - Completa la incorporación para configurar tu cuenta. + Primero, [crea una cuenta nueva](https://app.trophy.so/sign-up?utm_source=docs&utm_medium=quickstart) si aún no tienes una y dirígete al [panel de Trophy](https://app.trophy.so). + Completa el proceso de incorporación para configurar tu cuenta. - - Tenemos bibliotecas SDK disponibles en la mayoría de los principales lenguajes de programación, pero si no ves el tuyo en la lista, ¡háznoslo saber y crearemos uno! - + + Para la mejor experiencia de configuración con IA, conecta Trophy a través de MCP: - Alternativamente, puedes llamar directamente a la API usando cualquier cliente HTTP del lado del servidor. + - URL del servidor MCP de documentación: `https://docs.trophy.so/mcp` (contexto de documentación en vivo) + - URL del servidor MCP de cuenta: `https://mcp.trophy.so` (acciones de cuenta — consulta [MCP](/es/mcp/overview); requiere `x-trophy-api-key`) + + + Usa el [MCP de Documentación](/es/mcp/docs-mcp-server/introduction) como contexto de documentación bajo demanda y el [MCP de Cuenta](/es/mcp/account-mcp-server/introduction) para cambios en la cuenta. Usa ambos para [mejores prácticas](/es/mcp/best-practice). + - - Ve a la [página de integración](https://app.trophy.so/integration) del panel de Trophy y crea una nueva clave de API. - - Añade tu clave de API como variable de entorno en tu aplicación backend: + + Aquí tienes un prompt que puedes usar con tu agente de codificación para realizar la configuración inicial de Trophy: - + + Estoy añadiendo gamificación a mi aplicación usando Trophy. - Luego inicializa el cliente de la API de Trophy en tu backend usando esa clave de API: + Antes de realizar cambios, verifica que los servidores MCP de Trophy conectados estén disponibles. Usa el servidor MCP de Documentación como la fuente principal de información para los detalles de integración de Trophy, y el servidor MCP de Cuenta para configurar mi cuenta. - + Por favor, realiza la configuración inicial completa de principio a fin: + 1. Detecta el lenguaje/framework del backend en este repositorio e instala el SDK oficial de Trophy correspondiente (o usa llamadas HTTP si no hay SDK disponible). + 2. Añade `TROPHY_API_KEY` a la configuración de entorno de forma segura (sin secretos comprometidos en git), e intégralo en la inicialización del cliente de Trophy. + 3. Añade código para rastrear un evento de cambio de métrica para la métrica `` usando el cliente de la API de Trophy, conectando todos los atributos de usuario requeridos como ID, y usando placeholders para todos los atributos opcionales como nombre, email y zona horaria. + 4. Añade manejo básico de errores y registro de eventos alrededor de las llamadas a la API de Trophy. + 5. Añade o actualiza una sección breve en el README explicando cómo funciona la integración y cómo extenderla. - Asegúrate de que todas las llamadas al SDK de Trophy usen este cliente para la autenticación. - - - Todas las funciones de gamificación se basan en interacciones del usuario. En Trophy, usas [Métricas](/es/features/metrics) para definir y modelar esas interacciones y [Eventos](/es/features/events) para rastrearlas. - - Aquí crearás tu primera métrica para comenzar. En el panel de Trophy, dirígete a la [página de métricas](https://app.trophy.so/metrics) y pulsa el botón _Nueva métrica_: + Restricciones: + - Usa los resultados de la herramienta Docs MCP para todas las decisiones de implementación específicas de Trophy. + - No te bases en memoria previa para el comportamiento de la API de Trophy cuando MCP proporcione una respuesta. + - Mantén los secretos fuera del control de código fuente. + - Usa los patrones y convenciones de nomenclatura existentes del proyecto. + - Muéstrame un resumen conciso de los archivos modificados y cómo probar la configuración. + - Sugiere los siguientes pasos según las funciones de gamificación que Trophy admite. + - - - + + Asegúrate de reemplazar `` con la métrica que configuraste durante la incorporación. + - Asigna un nombre a la métrica y haz clic en _Guardar_. + Esto: + 1. Agregará el [SDK de Trophy](/es/api-reference/client-libraries) relevante a tu aplicación según tu stack tecnológico + 2. Agregará una nueva variable `TROPHY_API_KEY` a tu configuración de entorno + 3. Agregará código para enviar eventos a Trophy según la métrica que configuraste durante la incorporación. - - Una vez creada la métrica, ve a la pestaña de configuración y copia su clave de referencia única del API. + + Una vez completada la configuración, [crea una clave de API](https://app.trophy.so/integration) desde la página de integración del panel de Trophy y agrégala a tu entorno. + + + Una vez completada la configuración inicial, usa este mensaje de seguimiento para preparar tu agente para el siguiente paso y hacer que te pregunte qué construir a continuación: - - - + + Prepárate para continuar mi integración de Trophy desde la configuración existente. - Para rastrear un evento contra esta métrica cuando un usuario interactúa con tu producto, llama al [API de evento de cambio de métrica](/es/api-reference/endpoints/events/submit-a-metric-event), pasando los detalles del usuario que realizó la interacción. En este ejemplo, la clave de la métrica sería `flashcards-flipped`: + Primero, verifica que el servidor Docs MCP de Trophy conectado esté disponible y úsalo como fuente de verdad para los detalles de integración específicos de funciones. - + Antes de implementar cualquier cosa, pregúntame qué función de gamificación quiero construir, proporcionando opciones según lo que Docs MCP indique que Trophy admite. - Al realizar esta llamada, le indicas a Trophy que un usuario específico interactuó con tu producto. Como resultado, Trophy procesará automáticamente cualquier función de gamificación como Logros o Rachas que hayas configurado contra la métrica. + Después de elegir una opción: + 1. Configurar la funcionalidad seleccionada de la manera que describo usando el servidor MCP de cuenta. + 1. Implementar únicamente esa funcionalidad seleccionada usando las API relevantes de Trophy y los patrones de proyecto existentes. + 2. Agregar las llamadas/endpoints/acciones del lado del servidor necesarios que usen las API de Trophy y una superficie de respuesta de API o interfaz de usuario mínima. + 3. Documentar cualquier nueva variable de entorno, ruta y pasos de uso. - - - Con una métrica integrada en tu backend, estás listo para comenzar a agregar funciones de gamificación a tu producto. - - Sigue los enlaces a continuación para conocer más sobre cada función que puedes construir con Trophy: + Si solicito una funcionalidad que Trophy no admite, no implementar una solución alternativa. + En su lugar, indicarme que actualmente no está disponible y pedirme que contacte al soporte de Trophy en support@trophy.so para enviar una solicitud de funcionalidad. + + Mantener los cambios orientados a producción: + - Seguir la arquitectura y las convenciones de nomenclatura existentes. + - Manejar los fallos de la API con elegancia. + - Devolver una lista clara de archivos modificados y pasos de verificación manual. + + + Para obtener ideas sobre qué construir a continuación, explorar: - Recompensa a los usuarios por su progreso continuo o por realizar acciones específicas. + Recompensa a los usuarios por el progreso continuo o por realizar acciones específicas. - Motiva a los usuarios a desarrollar hábitos de uso regular. + Motiva a los usuarios a construir hábitos de uso regulares. Construye sistemas de puntos sofisticados para recompensar y retener usuarios. @@ -121,191 +140,99 @@ Aquí integrarás tu aplicación web backend con Trophy y comenzarás a construi Crea competencias amistosas para aumentar la participación de los usuarios. - Envía correos electrónicos de ciclo de vida personalizados a los usuarios en el momento perfecto. + Entrega correos electrónicos personalizados de ciclo de vida a los usuarios en el momento perfecto. - Impulsa flujos de notificación automatizados usando datos de gamificación personalizados. + Impulsa flujos de notificaciones automatizados usando datos de gamificación personalizados. O explora nuestra [referencia de API](/es/api-reference/introduction) para familiarizarte con lo que Trophy puede hacer. - - - Estas instrucciones son para quienes prefieren desarrollar usando agentes de codificación como Cursor y Claude Code. - + + Estas instrucciones son para quienes desean implementar Trophy manualmente. Si prefieres usar agentes de codificación, cambia de pestaña arriba. + - Primero, [crea una nueva cuenta](https://app.trophy.so/sign-up?utm_source=docs&utm_medium=quickstart) si aún no tienes una y dirígete al [panel de Trophy](https://app.trophy.so). - - Completa la incorporación para configurar tu cuenta. - - - - Para la mejor experiencia de configuración con IA, conecta Trophy a través de MCP, Agent Skill, o ambos: - - - URL del servidor MCP: `https://docs.trophy.so/mcp` - - URL de Agent Skill: `https://docs.trophy.so/skill.md` + Primero, [crea una cuenta nueva](https://app.trophy.so/sign-up?utm_source=docs&utm_medium=quickstart) si aún no tienes una y accede al [panel de Trophy](https://app.trophy.so). - - MCP le da a tu agente acceso en vivo a la documentación de Trophy. Agent Skill le proporciona instrucciones estructuradas sobre las capacidades de Trophy. Usar ambos generalmente ofrece los mejores resultados. - + Completa la configuración inicial para preparar tu cuenta. - - - 1. Abre [Conectores de Claude](https://claude.ai/settings/connectors). - 2. Selecciona **Agregar conector personalizado**. - 3. Agrega: - - Nombre: `Trophy` - - URL: `https://docs.trophy.so/mcp` - 4. En el chat, usa el botón de más para habilitar el conector de Trophy. - 5. Opcional pero recomendado: agrega Trophy Agent Skill en la [configuración de Habilidades de Claude](https://claude.ai/customize/skills) usando `https://docs.trophy.so/skill.md` para que Claude use consistentemente el resumen de capacidades de Trophy. - - - Agrega Trophy MCP: - - ```bash - claude mcp add --transport http Trophy https://docs.trophy.so/mcp - ``` - - Verifica: - - ```bash - claude mcp list - ``` - - Opcional: agrega Trophy Agent Skill: - - ```bash - npx skills add https://docs.trophy.so - ``` - - - - Abre la configuración de MCP y agrega esto a tu `mcp.json`: - - ```json - { - "mcpServers": { - "Trophy": { - "url": "https://docs.trophy.so/mcp" - } - } - } - ``` - - Opcional: agrega Trophy Agent Skill: - - ```bash - npx skills add https://docs.trophy.so - ``` - - - - Crea `.vscode/mcp.json`: - - ```json - { - "servers": { - "Trophy": { - "type": "http", - "url": "https://docs.trophy.so/mcp" - } - } - } - ``` + + + Tenemos bibliotecas SDK disponibles en la mayoría de los lenguajes de programación principales, pero si no ves el tuyo en la lista, ¡avísanos y crearemos uno! - Opcional: agrega Trophy Agent Skill: + - ```bash - npx skills add https://docs.trophy.so - ``` + Alternativamente, puedes llamar directamente a la API usando cualquier cliente HTTP del lado del servidor. - - - - Aquí hay un prompt que puedes usar con tu agente de codificación para realizar la configuración inicial de Trophy: + + Dirígete a la [página de integración](https://app.trophy.so/integration) del panel de Trophy y crea una nueva clave de API. + + Añade tu clave de API como una variable de entorno en tu aplicación backend: - - Estoy añadiendo gamificación a mi aplicación usando Trophy. + - Antes de realizar cambios, verifica que el servidor MCP `Trophy` conectado o la Agent Skill estén disponibles y úsalos como la fuente principal de información para los detalles de integración de Trophy. + Luego inicializa el cliente de API de Trophy en tu backend usando esa clave de API: - Por favor, realiza la configuración inicial completa de principio a fin: - 1. Detecta el lenguaje/framework del backend en este repositorio e instala el SDK oficial de Trophy correspondiente (o usa llamadas HTTP si no hay SDK disponible). - 2. Añade `TROPHY_API_KEY` a la configuración de entorno de forma segura (sin secretos comprometidos en git), e intégralo en la inicialización del cliente de Trophy. - 3. Añade código para rastrear un evento de cambio de métrica para la métrica `` usando el cliente de API de Trophy, conectando todos los atributos de usuario requeridos como ID, y usando placeholders para todos los atributos opcionales como nombre, email y zona horaria. - 4. Añade manejo básico de errores y logging alrededor de las llamadas a la API de Trophy. - 5. Añade o actualiza una sección breve en el README explicando cómo funciona la integración y cómo extenderla. + - Restricciones: - - Usa los resultados de la herramienta MCP de Trophy para todas las decisiones de implementación específicas de Trophy. - - Si el contexto de Agent Skill de Trophy está disponible en este entorno, síguelo. - - No dependas de memoria previa para el comportamiento de la API de Trophy cuando MCP o Agent proporcionen una respuesta. - - Mantén los secretos fuera del control de versiones. - - Usa los patrones y convenciones de nomenclatura existentes del proyecto. - - Muéstrame un resumen conciso de los archivos modificados y cómo probar la configuración. - - Sugiere los siguientes pasos basándote en las características de gamificación que Trophy soporta. - + Asegúrate de que todas las llamadas al SDK de Trophy utilicen este cliente para la autenticación. + + + Todas las funciones de gamificación se basan en interacciones de usuarios. En Trophy, usas [Métricas](/es/features/metrics) para definir y modelar esas interacciones y [Eventos](/es/features/events) para rastrearlas. + + Aquí crearás tu primera métrica para comenzar. En el panel de Trophy, ve a la [página de métricas](https://app.trophy.so/metrics) y haz clic en el botón _Nueva Métrica_: - - Asegúrate de reemplazar `` con la métrica que configuraste durante la incorporación. - + + + - Esto hará lo siguiente: + Asigna un nombre a la métrica y haz clic en _Guardar_. - 1. Agregar el [SDK de Trophy](/es/api-reference/client-libraries) correspondiente a tu aplicación según tu stack tecnológico - 2. Agregar una nueva variable `TROPHY_API_KEY` a la configuración de tu entorno - 3. Agregar código para enviar eventos a Trophy basándose en la métrica que configuraste durante la incorporación. - - - Una vez completada la configuración, [crea una clave API](https://app.trophy.so/integration) desde la página de integración del panel de Trophy y agrégala a tu entorno. - - Una vez completada la configuración inicial, utiliza este prompt de seguimiento para preparar tu agente para el siguiente paso y que te pregunte qué construir a continuación: - - - Prepárate para continuar mi integración de Trophy desde la configuración existente. - - Primero, verifica que el servidor MCP `Trophy` conectado o la habilidad del agente estén disponibles y utilízalos como fuente de referencia para los detalles de integración específicos de cada función. + + Una vez que hayas creado tu métrica, dirígete a la pestaña de configuración y copia su clave de referencia única de API. - Antes de implementar nada, pregúntame qué función de gamificación quiero construir, proporcionando opciones basadas en lo que el MCP de Trophy o la habilidad del agente indiquen que Trophy soporta. + + + - Después de que elija una opción: - 1. Implementa únicamente esa función seleccionada utilizando las APIs relevantes de Trophy y los patrones existentes del proyecto. - 2. Agrega las llamadas/endpoints/acciones del lado del servidor necesarias que utilicen las APIs de Trophy y una interfaz de usuario mínima o superficie de respuesta de API. - 3. Documenta cualquier nueva variable de entorno, ruta y pasos de uso. + Para registrar un evento contra esta métrica cuando un usuario interactúa con tu producto, llama a la [API de eventos de cambio de métrica](/es/api-reference/endpoints/events/submit-a-metric-event), pasando los detalles del usuario que realizó la interacción. En este ejemplo, la clave de métrica sería `flashcards-flipped`: - Si solicito una función que Trophy no soporta, no implementes una solución alternativa. - En su lugar, infórmame que no está soportada actualmente y pídeme que contacte al soporte de Trophy en support@trophy.so para enviar una solicitud de función. + - Mantén los cambios orientados a producción: - - Sigue la arquitectura existente y las convenciones de nomenclatura. - - Maneja los fallos de API de forma adecuada. - - Devuelve una lista clara de archivos modificados y pasos de verificación manual. - + Al hacer esta llamada, le estás indicando a Trophy que un usuario específico realizó una interacción con tu producto. Como resultado, Trophy procesará automáticamente cualquier característica de gamificación como Logros o Rachas que hayas configurado contra la métrica. - Para ideas sobre qué construir a continuación, explora: + + + Con una métrica integrada en tu backend, estás listo para comenzar a agregar características de gamificación a tu producto. + + Sigue los enlaces a continuación para aprender más sobre cada característica que puedes construir con Trophy: Recompensa a los usuarios por su progreso continuo o por realizar acciones específicas. - Motiva a los usuarios a desarrollar hábitos de uso regulares. + Motiva a los usuarios a desarrollar hábitos de uso regular. Construye sistemas de puntos sofisticados para recompensar y retener usuarios. @@ -328,22 +255,23 @@ Aquí integrarás tu aplicación web backend con Trophy y comenzarás a construi } href="/es/features/leaderboards"> - Crea competencias amistosas para aumentar la participación de los usuarios. + Crea competencias amistosas para aumentar la interacción de los usuarios. Envía correos electrónicos personalizados del ciclo de vida a los usuarios en el momento perfecto. - Impulsa flujos de notificaciones automatizadas utilizando datos de gamificación personalizados. + Impulsa flujos de notificación automatizados utilizando datos de gamificación personalizados. O explora nuestra [referencia de API](/es/api-reference/introduction) para familiarizarte con lo que Trophy puede hacer. + -## Obtén soporte {#get-support} +## Obtener Soporte {#get-support} ¿Quieres ponerte en contacto con el equipo de Trophy? Contáctanos por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/es/mcp/account-mcp-server/capabilities.mdx b/es/mcp/account-mcp-server/capabilities.mdx new file mode 100644 index 00000000..9dd588c1 --- /dev/null +++ b/es/mcp/account-mcp-server/capabilities.mdx @@ -0,0 +1,107 @@ +--- +title: Capacidades +description: Aprende qué puede hacer el servidor MCP de Trophy Account. +og:description: Aprende qué puede hacer el servidor MCP de Trophy Account. +icon: wrench +--- + +Una vez conectado, el servidor MCP de Account expone herramientas que tu agente puede llamar para inspeccionar y gestionar tu cuenta. + +La mayoría de los recursos ofrecen herramientas de **lectura** y **escritura** emparejadas: + +- Las herramientas de **lectura** listan y obtienen recursos +- Las herramientas de **escritura** crean o actualizan recursos por lotes para acelerar las operaciones + +## Herramientas de Métricas {#metrics-tools} + +Crea y gestiona las [Métricas](/es/features/metrics) que impulsan rachas, logros, puntos y clasificaciones. + +| Herramienta | Qué hace | +| --- | --- | +| `read_metrics` | Lista métricas u obtiene una sola métrica por ID | +| `write_metrics` | Crea o actualiza métricas | + +## Herramientas de Atributos {#attributes-tools} + +Gestiona [atributos de usuario personalizados](/es/features/users#custom-user-attributes) y [atributos de evento personalizados](/es/features/events#custom-event-attributes) utilizados para la segmentación de funciones y personalización. + +| Herramienta | Qué hace | +| --- | --- | +| `read_attributes` | Lista atributos u obtiene un solo atributo por ID | +| `write_attributes` | Crea o actualiza atributos | + +## Herramientas de Clasificaciones {#leaderboards-tools} + +Configura [Clasificaciones](/es/features/leaderboards) dentro de tu cuenta de Trophy. + +| Herramienta | Qué hace | +| --- | --- | +| `read_leaderboards` | Lista clasificaciones u obtiene una sola clasificación por ID | +| `write_leaderboards` | Crea o actualiza clasificaciones | + +## Herramientas de Puntos {#points-tools} + +Configura sistemas completos de [Puntos](/es/features/points), incluyendo [Desencadenadores](/es/features/points#points-triggers), [Niveles](/es/features/points#points-levels) y [Impulsos](/es/features/points#points-boosts). + +| Herramienta | Qué hace | +| --- | --- | +| `read_points_systems` | Lista sistemas de puntos u obtiene uno por ID | +| `write_points_systems` | Crea o actualiza sistemas de puntos (opcionalmente con desencadenadores, niveles e impulsos anidados) | +| `read_points_triggers` | Lista u obtiene desencadenadores para un sistema de puntos | +| `write_points_triggers` | Crea o actualiza desencadenadores para un sistema de puntos | +| `read_points_levels` | Lista u obtiene niveles para un sistema de puntos | +| `write_points_levels` | Crea o actualiza niveles para un sistema de puntos | +| `read_points_boosts` | Lista u obtiene impulsos para un sistema de puntos | +| `write_points_boosts` | Crea o actualiza impulsos para un sistema de puntos | + +## Herramientas de Clientes {#tenants-tools} + +Administra registros de organizaciones [multicliente](/es/platform/multi-tenancy) cuando la funcionalidad multicliente esté habilitada en tu cuenta. + +| Herramienta | Qué hace | +| --- | --- | +| `read_tenants` | Lista clientes u obtiene un cliente específico por ID | +| `write_tenants` | Crea o actualiza clientes | + + +Si la funcionalidad multicliente no está habilitada en tu cuenta, estas herramientas no funcionarán. + + +## Herramientas de Rachas {#streaks-tools} + +Ejecuta acciones operativas de [rachas](/es/features/streaks) para usuarios, como otorgar [congelaciones de racha](/es/features/streaks#streak-freezes) o [restaurar rachas](/es/features/streaks#restoring-a-users-streak). + +| Herramienta | Qué hace | +| --- | --- | +| `grant_streak_freezes` | Otorga congelaciones de racha a uno o más usuarios | +| `restore_streaks` | Restaura una racha interrumpida a su longitud anterior | + +## Ejemplos de Prompts {#example-prompts} + +Usa lenguaje natural — tu agente selecciona la herramienta y los parámetros adecuados: + +```text +Create an XP system called 'Kudos' that grants 10 points for each workout completed. +``` + +```text +Schedule 2X XP boosts for the 'Kudos' system across the next 3 weekends (only for paying users - 'plan' attribute is 'pro'). +``` + +```text +Grant two streak freezes to user user_123. +``` + +```text +user_123 wants their streak back, restore it to it's previous length. +``` + +## Alcance y Seguridad {#scope-and-safety} + +- Las herramientas solo actuarán en el [entorno](/es/platform/environments) de Trophy vinculado a la clave API que proporciones en `x-trophy-api-key`. +- Las herramientas de escritura pueden modificar la configuración en vivo. Prefiere un [entorno](/es/platform/environments) de staging o sandbox al iterar. +- Las herramientas no pueden eliminar recursos. + +## Obtén Soporte {#get-support} + +¿Quieres ponerte en contacto con el equipo de Trophy? Comunícate con nosotros por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/es/mcp/account-mcp-server/installation.mdx b/es/mcp/account-mcp-server/installation.mdx new file mode 100644 index 00000000..154a1746 --- /dev/null +++ b/es/mcp/account-mcp-server/installation.mdx @@ -0,0 +1,165 @@ +--- +title: Instalación +description: Instala el servidor MCP de cuenta en Claude Code, Cursor, VS Code y + otros clientes MCP. +subtitle: Conecta el servidor MCP de cuenta remoto a tu agente de codificación. +icon: download +--- + + + Necesitas una [cuenta de Trophy](https://app.trophy.so/sign-up) para usar el servidor MCP de cuenta de Trophy. + + +El servidor MCP de cuenta de Trophy es un servidor MCP HTTP remoto. Diriges tu cliente a la URL indicada a continuación usando tu [clave API de administrador](/es/admin-api/authentication) y tu agente podrá comenzar a usar las herramientas. + +```bash Server URL +https://mcp.trophy.so +``` + +## Instalar en tu cliente {#install-in-your-client} + +Nombra este servidor de forma clara (por ejemplo `Trophy Account`) para que no colisione con el [servidor MCP de documentación](/es/mcp/docs-mcp-server/installation). + + + Reemplaza `YOUR_ADMIN_API_KEY` con una clave API de la [página de integraciones](https://app.trophy.so/integration) del panel de Trophy. + + + + + Agrega el servidor remoto con una entrada `headers` para la clave API: + + ```bash + claude mcp add-json "Trophy Account" '{ + "type": "http", + "url": "https://mcp.trophy.so", + "headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" + } + }' + ``` + + Para obtener la clave desde el entorno en lugar de incluirla directamente: + + ```bash + claude mcp add-json "Trophy Account" "{ + \"type\": \"http\", + \"url\": \"https://mcp.trophy.so\", + \"headers\": { + \"x-trophy-api-key\": \"${TROPHY_API_KEY}\" + } + }" + ``` + + Verifica que aparezca en tu lista: + + ```bash + claude mcp list + ``` + + + + Abre la configuración de MCP y agrega esto a tu `mcp.json`: + + ```json + { + "mcpServers": { + "Trophy Account": { + "url": "https://mcp.trophy.so", + "headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" + } + } + } + } + ``` + + Si prefieres no almacenar la clave en el archivo, usa la sustitución de entorno de Cursor donde esté disponible: + + ```json + { + "mcpServers": { + "Trophy Account": { + "url": "https://mcp.trophy.so", + "headers": { + "x-trophy-api-key": "${env:TROPHY_API_KEY}" + } + } + } + } + ``` + + Reinicia Cursor si es necesario para que el servidor y los encabezados se carguen. + + + Crea o actualiza `.vscode/mcp.json` en tu espacio de trabajo: + + ```json + { + "servers": { + "Trophy Account": { + "type": "http", + "url": "https://mcp.trophy.so", + "headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" + } + } + } + } + ``` + + Recarga VS Code y habilita el servidor. + + + Cualquier cliente MCP que admita servidores HTTP remotos y una configuración `headers` puede conectarse. + + Usa: + + - **Transporte:** HTTP (HTTP con streaming) + - **URL:** `https://mcp.trophy.so` + - **Nombre:** `Trophy Account` (o cualquier etiqueta que prefieras) + - **headers:** + + ```json + { + "headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" + } + } + ``` + + + + +## Verificar la conexión {#verify-the-connection} + +Pregunta a tu agente algo que requiera una llamada a la cuenta activa, por ejemplo: + +```text +List the metrics in my Trophy account. +``` + +Si la autenticación fue exitosa, deberías obtener métricas de tu organización. Si recibes un error de autenticación o no autorizado, confirma que la clave sea válida y que la configuración de tu cliente incluya: + +```json +"headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" +} +``` + +## Próximos pasos {#next-steps} + + + + Explora qué herramientas expone el servidor MCP de cuenta. + + + Agrega contexto de documentación bajo demanda para tu agente. + + + Formas recomendadas de trabajar con agentes y MCP. + + + +## Obtener soporte {#get-support} + +¿Quieres ponerte en contacto con el equipo de Trophy? Contáctanos por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/es/mcp/account-mcp-server/introduction.mdx b/es/mcp/account-mcp-server/introduction.mdx new file mode 100644 index 00000000..be766843 --- /dev/null +++ b/es/mcp/account-mcp-server/introduction.mdx @@ -0,0 +1,56 @@ +--- +title: Introducción +description: Aprende sobre el servidor MCP de cuenta y por qué existe para agentes de IA. +subtitle: Proporciona a los agentes de IA acceso seguro y estructurado a tu + cuenta de Trophy. +--- + +El servidor MCP de cuenta es un servidor remoto de [Model Context Protocol](https://modelcontextprotocol.io) que permite a los agentes de IA leer y gestionar la configuración de gamificación en tu cuenta de Trophy. + +En lugar de copiar y pegar clics del panel de control en el chat, puedes pedirle a tu agente que inspeccione Métricas, cree sistemas de Puntos, actualice Clasificaciones, restaure Rachas y más. + +```bash Server URL +https://mcp.trophy.so +``` + +## ¿Por qué el MCP de cuenta? {#why-the-account-mcp} + +Los agentes de programación con IA ya son donde los equipos diseñan y envían trabajo de producto, y Trophy ha simplificado esto al proporcionar infraestructura preconstruida para crear funciones comunes de gamificación. Sin embargo, esto implica en gran medida mirar pantallas y hacer clic en botones. + +El servidor MCP de cuenta es la **capa de acción**: después de que el agente comprende *qué* construir (a menudo a través del [servidor MCP de documentación](/es/mcp/docs-mcp-server/introduction)), puede descubrir la configuración de cuenta en vivo, realizar cambios específicos y validar resultados sin que un humano toque el panel de control. + +Esto abre un nuevo flujo de trabajo para los equipos donde los agentes pueden razonar sobre qué funciones de gamificación construir, entender cómo mapear eso a las funciones de Trophy y configurar una cuenta de Trophy que logre todo esto dentro del chat. + +Los flujos de trabajo típicos incluyen: + +- Estructurar Métricas, atributos y sistemas de Puntos mientras se integra Trophy en una nueva aplicación +- Inspeccionar Clasificaciones existentes o configuración de Puntos antes de cambiar código de producción +- Ejecutar tareas operativas como otorgar congelaciones o restaurar Rachas desde el chat + +## Cómo funciona {#how-it-works} + +Trophy aloja un endpoint MCP remoto. Lo instalas una vez en tu cliente MCP, te autenticas con una clave API de administrador desde la [página de integraciones](https://app.trophy.so/integration) bajo una configuración `headers` (`x-trophy-api-key`), y el cliente expone herramientas que tu agente puede llamar. + +Estas herramientas corresponden a operaciones de cuenta: list/get para descubrimiento, create/update para configuración, y acciones dedicadas para congelaciones de Racha, restauraciones y lectura de analíticas. + + + El servidor MCP de cuenta está diseñado para flujos de trabajo basados en chat y agentes. Para scripts, trabajos backend o integraciones de producción, utiliza la [API de administración](/es/admin-api/introduction). + + +## Primeros pasos {#get-started} + + + + Conecta el servidor MCP en Claude, Cursor, VS Code y otros clientes. + + + Consulta las herramientas que tu agente puede usar una vez conectado. + + + Formas recomendadas de trabajar con agentes y MCP. + + + +## Obtener soporte {#get-support} + +¿Quieres ponerte en contacto con el equipo de Trophy? Contáctanos por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/es/mcp/best-practice.mdx b/es/mcp/best-practice.mdx new file mode 100644 index 00000000..bb4d0677 --- /dev/null +++ b/es/mcp/best-practice.mdx @@ -0,0 +1,65 @@ +--- +title: Mejores Prácticas +description: Cómo usar los servidores MCP de Docs y Account de Trophy juntos. +og:description: Cómo usar los servidores MCP de Docs y Account de Trophy juntos. +--- + +El servidor MCP de Docs de Trophy y el servidor MCP de Account están diseñados para usarse juntos. Esta página cubre las formas recomendadas de utilizarlos. + +## Usar Ambos Servidores Juntos {#using-both-servers-together} + +Instala ambos servidores en tu cliente MCP usando nombres distintos para que las herramientas sean fáciles de identificar: + +| Nombre recomendado | URL | +| --- | --- | +| `Trophy Docs` | `https://docs.trophy.so/mcp` | +| `Trophy Account` | `https://mcp.trophy.so/mcp` | + +Guías de instalación: [MCP de Docs](/es/mcp/docs-mcp-server/installation), [MCP de Account](/es/mcp/account-mcp-server/installation). + +## MCP de Docs: Documentación en Vivo {#docs-mcp-live-documentation} + +Usa el MCP de Docs como contexto en vivo sobre cómo funciona Trophy. Úsalo cuando necesites: + +- Entender el comportamiento de las funcionalidades de Trophy en detalle +- Generar ideas sobre cómo resolver tu caso de uso específico de gamificación +- Encontrar el API correcto para llamar + +El servidor MCP de Docs de Trophy es **de solo lectura** y siempre lee documentación pública en vivo, úsalo en lugar de copias locales para asegurarte de tener la información más actualizada. + +Consulta las [capacidades del MCP de Docs](/es/mcp/docs-mcp-server/capabilities) para más detalles. + +## MCP de Account: Configuración y Operaciones de Cuenta {#account-mcp-account-configuration-and-operations} + +Usa el MCP de Account cuando necesites realizar acciones en tu cuenta de Trophy. Úsalo cuando necesites: + +- Leer la configuración de tu cuenta de Trophy, por ejemplo, métricas, clasificaciones, etc. +- Configurar recursos nuevos o actualizar los existentes en tu cuenta de Trophy mediante chat. +- Completar tareas operativas como conceder congelaciones o restaurar rachas. + +El acceso está limitado a un [entorno](/es/platform/environments) específico de Trophy mediante [claves de API de administrador](/es/admin-api/authentication). + +Consulta las [capacidades del servidor MCP de cuenta](/es/mcp/account-mcp-server/capabilities) para obtener más detalles. + +## Flujo de trabajo recomendado {#recommended-workflow} + +Para la mayoría del trabajo agéntico con Trophy, usa ambos servidores en conjunto: + +1. **MCP de documentación** — carga el comportamiento de la función o API que necesita la tarea +2. **MCP de cuenta (lectura)** — lista los recursos relacionados para que el trabajo se base en lo que ya existe +3. **MCP de cuenta (escritura)** — crea o actualiza solo lo que requiere la tarea +4. **Tu aplicación** — implementa llamadas a la API de aplicación en código usando las estructuras respaldadas por la documentación y tus claves API +5. **Verificar** — vuelve a leer el estado de la cuenta o la documentación si algo falla + +### Ejemplo de prompt {#example-prompt} + +```text +Using Trophy Docs MCP, review how metrics and event tracking works. +Using Trophy Account MCP, list my existing metrics. +Create a new 'workouts completed' metric if one does not already exist. +Then integrate event tracking to this metric in my code based on the docs. +``` + +## Obtener soporte {#get-support} + +¿Quieres contactar al equipo de Trophy? Comunícate con nosotros por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/es/mcp/docs-mcp-server/capabilities.mdx b/es/mcp/docs-mcp-server/capabilities.mdx new file mode 100644 index 00000000..40cfd766 --- /dev/null +++ b/es/mcp/docs-mcp-server/capabilities.mdx @@ -0,0 +1,91 @@ +--- +title: Capacidades +description: Aprende qué puede hacer el servidor MCP de Trophy Docs. +og:description: Aprende qué puede hacer el servidor MCP de Trophy Docs. +icon: wrench +--- + +El servidor MCP de Trophy Docs expone un pequeño conjunto de herramientas de **solo lectura** limitadas a la documentación pública de Trophy. Los agentes deben preferir estas herramientas sobre la memoria previa para preguntas específicas de Trophy. + +## Búsqueda {#search} + +| Herramienta | Qué hace | +| --- | --- | +| `search_trophy_docs` | Búsqueda semántica en la base de conocimientos de la documentación; devuelve fragmentos relevantes, títulos y rutas de página | + +Usa la búsqueda para preguntas conceptuales o de "cómo hago…" — autenticación, Límites de velocidad, comportamiento de funciones, patrones de integración. + +Ejemplos de prompts: + +```text +Search Trophy docs for how points boosts work. +``` + +```text +Find the Application API endpoint for submitting a metric event. +``` + +## Leer páginas de documentación {#read-documentation-pages} + +| Herramienta | Qué hace | +| --- | --- | +| `query_docs_filesystem_trophy_docs` | Ejecuta consultas de solo lectura estilo shell contra un sistema de archivos virtual de páginas de documentación y especificaciones OpenAPI | + +Así es como el agente lee páginas completas una vez que la búsqueda devuelve una ruta. No existe una herramienta separada de "obtener página" — el agente usa comandos como `head`, `cat`, `rg`, `tree`, o `ls` contra rutas como `/features/streaks.mdx` o `/api-reference/introduction.mdx`. + +Patrones comunes: + +- `tree / -L 2` — explorar la estructura de la documentación +- `rg -il "rate limit" /` — coincidencias exactas de palabras clave o regex +- `head -80 /getting-started/quickstart.mdx` — leer la parte superior de una página +- `cat /openapi/application.json | jq '...'` — inspeccionar OpenAPI cuando importa el detalle del esquema + +La salida se trunca por llamada, por lo que los buenos agentes usan lecturas específicas en lugar de volcar archivos grandes completos. + +Ejemplos de prompts: + +```text +Open the streaks feature page and summarize freeze behavior. +``` + +```text +From the Application API OpenAPI, list the user endpoints. +``` + +## Comentarios {#feedback} + +| Herramienta | Qué hace | +| --- | --- | +| `submit_feedback` | Reportar documentación incorrecta, desactualizada, incompleta o confusa al equipo de documentación de Trophy | + +Esto es para problemas de **contenido de documentación** (ejemplo incorrecto, paso faltante, explicación incorrecta), no para soporte del producto o ayuda con la cuenta. + +Ejemplo de prompt: + +```text +The rate limiting page example looks wrong — file docs feedback on /api-reference/rate-limiting. +``` + +## Lo Que No Hace {#what-it-does-not-do} + +El Servidor MCP de Docs no puede: + +- Acceder o modificar recursos en tu organización de Trophy +- Llamar APIs de Trophy + +Para operaciones de cuenta, instala el [Servidor MCP de Cuenta](/es/mcp/account-mcp-server/capabilities). + +## Próximos Pasos {#next-steps} + + + + Instala el Servidor MCP de Cuenta en tu cliente MCP. + + + Conoce lo que puede hacer el MCP de Cuenta de Trophy. + + + +## Obtener Soporte {#get-support} + +¿Quieres comunicarte con el equipo de Trophy? Contáctanos por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/es/mcp/docs-mcp-server/installation.mdx b/es/mcp/docs-mcp-server/installation.mdx new file mode 100644 index 00000000..516b4cf8 --- /dev/null +++ b/es/mcp/docs-mcp-server/installation.mdx @@ -0,0 +1,111 @@ +--- +title: Instalación +description: Instala el servidor MCP de Trophy Docs en Claude, Claude Code, + Cursor, VS Code y otros clientes MCP. +subtitle: Conecta la documentación de Trophy en vivo a tu agente de programación. +icon: download +--- + +El servidor MCP de Docs es un servidor MCP HTTP remoto. Apunta tu cliente a la URL a continuación y tu agente podrá buscar y leer la documentación de Trophy bajo demanda. + +```bash Server URL +https://docs.trophy.so/mcp +``` + +No se requiere una cuenta de Trophy para el servidor MCP de Docs, expone documentación pública en vivo. + +## Instalar en tu cliente {#install-in-your-client} + +Nombra este servidor de forma clara (por ejemplo `Trophy Docs`) para que no entre en conflicto con el [servidor MCP de cuenta](/es/mcp/account-mcp-server/installation) utilizado para acciones de cuenta. + + + + 1. Abre [Claude Connectors](https://claude.ai/new#settings/customize-connectors). + 2. Selecciona **Agregar > Agregar conector personalizado**. + 3. Añade: + - Nombre: `Trophy Docs` + - URL: `https://docs.trophy.so/mcp` + 4. En el chat, utiliza el botón más para habilitar el conector de Trophy Docs. + + + Añade el servidor de docs: + + ```bash + claude mcp add --transport http "Trophy Docs" https://docs.trophy.so/mcp + ``` + + Verifica: + + ```bash + claude mcp list + ``` + + + + Abre la configuración de MCP y añade esto a tu `mcp.json`: + + ```json + { + "mcpServers": { + "Trophy Docs": { + "url": "https://docs.trophy.so/mcp" + } + } + } + ``` + + Es posible que necesites reiniciar Cursor si el servidor no aparece en tu lista de MCP. + + + Crea o actualiza `.vscode/mcp.json` en tu espacio de trabajo: + + ```json + { + "servers": { + "Trophy Docs": { + "type": "http", + "url": "https://docs.trophy.so/mcp" + } + } + } + ``` + + Recarga VS Code y habilita el servidor. + + + Cualquier cliente MCP que admita servidores HTTP remotos puede conectarse. + + Utiliza: + + - **Transporte:** HTTP (HTTP con streaming) + - **URL:** `https://docs.trophy.so/mcp` + - **Nombre:** `Trophy Docs` (recomendado) + + Después de añadir el servidor, habilítalo en la interfaz del cliente si es necesario. + + + +## Verificar la conexión {#verify-the-connection} + +Pregunta a tu agente una cuestión exclusiva de documentación, por ejemplo: + +```text +Using the Trophy Docs MCP, explain how to authenticate Application API requests. +``` + +Deberías obtener una respuesta fundamentada en la búsqueda de documentación o en una página de documentación específica, con enlaces de vuelta a docs.trophy.so. + +## Próximos Pasos {#next-steps} + + + + Descubre qué pueden hacer las herramientas del Docs MCP. + + + Formas recomendadas de trabajar con agentes y MCP. + + + +## Obtener Soporte {#get-support} + +¿Quieres ponerte en contacto con el equipo de Trophy? Comunícate con nosotros por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/es/mcp/docs-mcp-server/introduction.mdx b/es/mcp/docs-mcp-server/introduction.mdx new file mode 100644 index 00000000..3a2c5edc --- /dev/null +++ b/es/mcp/docs-mcp-server/introduction.mdx @@ -0,0 +1,54 @@ +--- +title: Introducción +description: Aprende sobre el servidor MCP de documentación de Trophy y por qué + los agentes deben usarlo para obtener contexto de documentación en tiempo + real. +subtitle: Documentación de Trophy bajo demanda para cualquier agente de + codificación de IA. +--- + +El servidor MCP de documentación de Trophy es un servidor remoto del [Protocolo de Contexto de Modelo](https://modelcontextprotocol.io) que proporciona a los agentes de IA acceso en tiempo real a la documentación de Trophy: guías, páginas de funciones, referencias de API y especificaciones OpenAPI. + +Piensa en él como una **habilidad bajo demanda**: en lugar de depender de los datos de entrenamiento del modelo, tu agente puede buscar y abrir la misma documentación que lees en docs.trophy.so cuando necesite detalles precisos y actualizados. + +```bash Server URL +https://docs.trophy.so/mcp +``` + +## ¿Por qué un MCP de documentación? {#why-a-docs-mcp} + +Trophy cambia: se lanzan nuevos endpoints, los parámetros evolucionan y las guías se actualizan. Los agentes que solo utilizan conocimiento integrado corren el riesgo de inventar APIs, omitir restricciones o enviar integraciones basadas en patrones obsoletos. + +El MCP de documentación mantiene ese contexto actualizado. Antes de integrar una función o explicar una carga útil, el agente puede extraer el fragmento de documentación más reciente o la página completa y trabajar desde la fuente de verdad. + +Usos típicos: + +- Responder "¿cómo funciona X?" desde la documentación publicada antes de escribir código +- Consultar formas de solicitud/respuesta y patrones de autenticación desde las páginas de referencia de API +- Seguir guías de funciones (Rachas, Puntos, Clasificaciones) mientras se implementan eventos de backend +- Explorar especificaciones OpenAPI cuando el agente necesita detalles exactos de ruta o esquema + +## Cómo funciona {#how-it-works} + +Trophy aloja un endpoint MCP remoto respaldado por el sitio de documentación público. Lo instalas en tu cliente MCP; el agente obtiene herramientas para **buscar** en la base de conocimiento y **leer** páginas completas desde un sistema de archivos de documentación aislado. + +El servidor es de **solo lectura**. No accede a tu cuenta de Trophy, no muta la configuración ni llama a las APIs de Trophy. Para acciones de cuenta, utiliza el [servidor MCP de cuenta](/es/mcp/account-mcp-server/introduction). + + + Los mejores resultados se obtienen al instalar **ambos** servidores: documentos para contexto, Account MCP para acción. Consulta [Mejores prácticas](/es/mcp/best-practice). + + +## Primeros Pasos {#get-started} + + + + Conecta el Docs MCP Server en clientes comunes. + + + Descubre cómo funcionan las herramientas de búsqueda y lectura de páginas. + + + +## Obtener Soporte {#get-support} + +¿Quieres ponerte en contacto con el equipo de Trophy? Contáctanos por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/es/mcp/overview.mdx b/es/mcp/overview.mdx new file mode 100644 index 00000000..2a30701e --- /dev/null +++ b/es/mcp/overview.mdx @@ -0,0 +1,45 @@ +--- +title: Descripción general +description: Usa agentes de IA para crear experiencias de producto gamificadas con Trophy. +og:description: Usa agentes de IA para crear experiencias de producto gamificadas con Trophy. +--- + + + Los servidores MCP de Trophy están actualmente en beta y pueden cambiar. + + +Trophy mantiene dos servidores remotos de [Model Context Protocol](https://modelcontextprotocol.io) para permitir que agentes de IA como ChatGPT, Cursor y Claude creen experiencias de producto gamificadas con Trophy. + +| Servidor | Para qué sirve | +| --- | --- | +| [Servidor MCP de documentación](/es/mcp/docs-mcp-server/introduction) | Documentación en vivo — busca guías y referencia de API (como una habilidad bajo demanda) | +| [Servidor MCP de cuenta](/es/mcp/account-mcp-server/introduction) | Acciones de cuenta — gestiona métricas, puntos, clasificaciones, rachas y más | + +Puedes usar cualquiera de los servidores por separado, pero se obtienen mejores resultados siguiendo las [mejores prácticas](/es/mcp/best-practice) usando ambos servidores juntos. + +## Qué puedes hacer {#what-you-can-do} + +Con agentes conectados a los servidores MCP de Trophy puedes: + +- Incorporar integraciones más rápido permitiendo que los agentes de codificación lean la documentación mientras escriben código +- Configurar estructura (métricas, atributos, sistemas de puntos, clasificaciones) mediante chat +- Comprender el comportamiento del usuario pidiendo a los agentes que resuman las analíticas de la cuenta. +- Ejecutar tareas operativas como conceder congelaciones o restaurar rachas + +## Empieza aquí {#start-here} + + + + Cómo recomendamos usar los servidores MCP de Trophy. + + + Cómo usar el servidor MCP de documentación de Trophy. + + + Cómo usar el servidor MCP de cuenta de Trophy. + + + +## Obtén soporte {#get-support} + +¿Quieres ponerte en contacto con el equipo de Trophy? Contáctanos por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/getting-started/quickstart.mdx b/getting-started/quickstart.mdx index 04bcfa7e..684b7b16 100644 --- a/getting-started/quickstart.mdx +++ b/getting-started/quickstart.mdx @@ -11,84 +11,103 @@ import TrophyClientInitBlock from "../snippets/trophy-client-init-block.mdx"; import MetricChangeRequestBlock from "../snippets/metric-change-request-block.mdx"; import MetricChangeResponseBlock from "../snippets/metric-change-response-block.mdx"; -Here you'll integrate your backend web application with Trophy and start building your first gamified feature. +Here you'll integrate your application with Trophy and start building your first gamified feature. - - These instructions are for those who want to implement Trophy by hand. If instead you prefer to use coding agents, switch tabs above. - + + These instructions are for those who prefer to develop using coding agents like Cursor and Claude Code. + First, [create a new account](https://app.trophy.so/sign-up?utm_source=docs&utm_medium=quickstart) if you don't already have one and head into the [Trophy dashboard](https://app.trophy.so). Head through onboarding to get your account set up. - - - We have SDK libraries available in most major programming languages but if you don't see yours listed, let us know and we'll make one! - + + For the best AI setup experience, connect Trophy through MCP: - Alternatively, you can directly call the API using any server-side HTTP client. + - Docs MCP server URL: `https://docs.trophy.so/mcp` (live documentation context) + - Account MCP server URL: `https://mcp.trophy.so` (account actions — see [MCP](/mcp/overview); requires `x-trophy-api-key`) + + + Use the [Docs MCP](/mcp/docs-mcp-server/introduction) as on-demand docs context and the [Account MCP](/mcp/account-mcp-server/introduction) for account changes. Use both for [best practice](/mcp/best-practice). + - - Head to the [integration page](https://app.trophy.so/integration) of the Trophy dashboard and create a new API key. - - Add your API key as an environment variable in your backend application: + + Here's a prompt you can use with your coding agent to perform initial Trophy setup: - + + I'm adding gamification to my app using Trophy. - Then initialize the Trophy API client in your backend using that API key: + Before making changes, verify the connected Trophy MCP Servers are available. Use the Docs MCP server as the primary source of truth for Trophy integration details, and the Account MCP server to configure my account. - + Please do the full initial setup end-to-end: + 1. Detect the backend language/framework in this repo and install the relevant official Trophy SDK (or use HTTP calls if no SDK is available). + 2. Add `TROPHY_API_KEY` to environment config in a secure way (no secrets committed to git), and wire it into the Trophy client initialization. + 3. Add code to track a metric change event for the metric `` using the Trophy API client, wiring all required user attributes like ID, and using placeholders for all optional attributes like name, email and tz. + 4. Add basic error handling and logging around Trophy API calls. + 5. Add or update a short README section explaining how the integration works and how to extend it. - Make sure all Trophy SDK calls use this client for authentication. - - - All gamification features are driven by user interactions. In Trophy, you use [Metrics](/features/metrics) to define and model those interactions and [Events](/features/events) to track them. - - Here you'll create your first metric to get started. In the Trophy dashboard, head into the [metrics page](https://app.trophy.so/metrics) and hit the _New Metric_ button: + Constraints: + - Use Docs MCP tool results for all Trophy-specific implementation decisions. + - Do not rely on prior memory for Trophy API behavior when MCP provides an answer. + - Keep secrets out of source control. + - Use existing project patterns and naming conventions. + - Show me a concise summary of changed files and how to test the setup. + - Suggest next steps based on the gamification features Trophy supports. + - - - + + Make sure to replace `` with the metric you set up during onboarding. + - Give the metric a name and hit _Save_. + This will: + 1. Add the relevant [Trophy SDK](/api-reference/client-libraries) to your app based on your tech stack + 2. Add a new `TROPHY_API_KEY` variable to your environment settings + 3. Add code to send events to Trophy based on the metric you set up during onboarding. - - Once you've created your metric, head to the configure tab and copy it's unique API reference key. + + Once the set up is complete, [create an API key](https://app.trophy.so/integration) from the integration page of the Trophy dashboard and add it to your environment. + + + Once initial setup is complete, use this follow-up prompt to prepare your agent for the next step and have it ask you what to build next: - - - + + Prepare to continue my Trophy integration from the existing setup. - To track an event against this metric when a user interacts with your product, call the [metric change event API](/api-reference/endpoints/events/submit-a-metric-event), passing along details of the user that made the interaction. In this example the metric key would be `flashcards-flipped`: + First, verify the connected Trophy Docs MCP server is available and use it as the source of truth for feature-specific integration details. - + Before implementing anything, ask me which gamification feature I want to build, providing options based on what the Docs MCP says Trophy supports. - By making this call, you're telling Trophy that a specific user made an interaction with your product. As a result, Trophy will process any gamification features like achievements or streaks that you've configured against the metric automatically. + After I choose one option: + 1. Configure the selected feature in the way I describe using the Account MCP server. + 1. Implement only that selected feature using the relevant Trophy APIs and existing project patterns. + 2. Add the required server-side calls/endpoints/actions that use Trophy APIs and a minimal UI or API response surface. + 3. Document any new env vars, routes, and usage steps. - - - With a metric integrated into your backend, you're ready to start adding gamification features to your product. - - Follow the links below to learn more about each feature you can build with Trophy: + If I ask for a feature Trophy does not support, do not implement a workaround. + Instead, tell me it's not currently supported and ask me to contact Trophy support at support@trophy.so to submit a feature request. + + Keep changes production-minded: + - Follow existing architecture and naming conventions. + - Handle API failures gracefully. + - Return a clear list of changed files and manual verification steps. + + + For ideas on what to build next, explore: @@ -129,176 +148,84 @@ Here you'll integrate your backend web application with Trophy and start buildin Or, explore our [API reference](/api-reference/introduction) to get familiar with what Trophy can do. - - - These instructions are for those who prefer to develop using coding agents like Cursor and Claude Code. - + + These instructions are for those who want to implement Trophy by hand. If instead you prefer to use coding agents, switch tabs above. + First, [create a new account](https://app.trophy.so/sign-up?utm_source=docs&utm_medium=quickstart) if you don't already have one and head into the [Trophy dashboard](https://app.trophy.so). Head through onboarding to get your account set up. - - - - For the best AI setup experience, connect Trophy through MCP, Agent Skill, or both: - - - MCP server URL: `https://docs.trophy.so/mcp` - - Agent skill URL: `https://docs.trophy.so/skill.md` - - MCP gives your agent live access to Trophy docs. Agent Skill gives it structured instructions about Trophy capabilities. Using both usually gives the best results. - - - - - 1. Open [Claude Connectors](https://claude.ai/settings/connectors). - 2. Select **Add custom connector**. - 3. Add: - - Name: `Trophy` - - URL: `https://docs.trophy.so/mcp` - 4. In chat, use the plus button to enable the Trophy connector. - 5. Optional but recommended: add Trophy Agent Skill in [Claude Skills settings](https://claude.ai/customize/skills) using `https://docs.trophy.so/skill.md` so Claude consistently uses Trophy's capability summary. - - - Add Trophy MCP: - - ```bash - claude mcp add --transport http Trophy https://docs.trophy.so/mcp - ``` - - Verify: - - ```bash - claude mcp list - ``` - - Optional: add Trophy Agent Skill: - - ```bash - npx skills add https://docs.trophy.so - ``` - - - - Open MCP settings and add this to your `mcp.json`: - - ```json - { - "mcpServers": { - "Trophy": { - "url": "https://docs.trophy.so/mcp" - } - } - } - ``` - - Optional: add Trophy Agent Skill: - - ```bash - npx skills add https://docs.trophy.so - ``` - - - - Create `.vscode/mcp.json`: - - ```json - { - "servers": { - "Trophy": { - "type": "http", - "url": "https://docs.trophy.so/mcp" - } - } - } - ``` + + + We have SDK libraries available in most major programming languages but if you don't see yours listed, let us know and we'll make one! - Optional: add Trophy Agent Skill: + - ```bash - npx skills add https://docs.trophy.so - ``` + Alternatively, you can directly call the API using any server-side HTTP client. - - - - Here's a prompt you can use with your coding agent to perform initial Trophy setup: + + Head to the [integration page](https://app.trophy.so/integration) of the Trophy dashboard and create a new API key. + + Add your API key as an environment variable in your backend application: - - I'm adding gamification to my app using Trophy. + - Before making changes, verify the connected `Trophy` MCP server or Agent Skill is available and use it as the primary source of truth for Trophy integration details. + Then initialize the Trophy API client in your backend using that API key: - Please do the full initial setup end-to-end: - 1. Detect the backend language/framework in this repo and install the relevant official Trophy SDK (or use HTTP calls if no SDK is available). - 2. Add `TROPHY_API_KEY` to environment config in a secure way (no secrets committed to git), and wire it into the Trophy client initialization. - 3. Add code to track a metric change event for the metric `` using the Trophy API client, wiring all required user attributes like ID, and using placeholders for all optional attributes like name, email and tz. - 4. Add basic error handling and logging around Trophy API calls. - 5. Add or update a short README section explaining how the integration works and how to extend it. + - Constraints: - - Use Trophy MCP tool results for all Trophy-specific implementation decisions. - - If Trophy Agent Skill context is available in this environment, follow it. - - Do not rely on prior memory for Trophy API behavior when MCP or Agent provides an answer. - - Keep secrets out of source control. - - Use existing project patterns and naming conventions. - - Show me a concise summary of changed files and how to test the setup. - - Suggest next steps based on the gamification features Trophy supports. - + Make sure all Trophy SDK calls use this client for authentication. + + + All gamification features are driven by user interactions. In Trophy, you use [Metrics](/features/metrics) to define and model those interactions and [Events](/features/events) to track them. + + Here you'll create your first metric to get started. In the Trophy dashboard, head into the [metrics page](https://app.trophy.so/metrics) and hit the _New Metric_ button: - - Make sure to replace `` with the metric you set up during onboarding. - + + + - This will: + Give the metric a name and hit _Save_. - 1. Add the relevant [Trophy SDK](/api-reference/client-libraries) to your app based on your tech stack - 2. Add a new `TROPHY_API_KEY` variable to your environment settings - 3. Add code to send events to Trophy based on the metric you set up during onboarding. - - Once the set up is complete, [create an API key](https://app.trophy.so/integration) from the integration page of the Trophy dashboard and add it to your environment. - - - Once initial setup is complete, use this follow-up prompt to prepare your agent for the next step and have it ask you what to build next: - - - Prepare to continue my Trophy integration from the existing setup. - - First, verify the connected `Trophy` MCP server or Agent skill is available and use it as the source of truth for feature-specific integration details. + + Once you've created your metric, head to the configure tab and copy it's unique API reference key. - Before implementing anything, ask me which gamification feature I want to build, providing options based on what the Trophy MCP or Agent Skill says Trophy supports. + + + - After I choose one option: - 1. Implement only that selected feature using the relevant Trophy APIs and existing project patterns. - 2. Add the required server-side calls/endpoints/actions that use Trophy APIs and a minimal UI or API response surface. - 3. Document any new env vars, routes, and usage steps. + To track an event against this metric when a user interacts with your product, call the [metric change event API](/api-reference/endpoints/events/submit-a-metric-event), passing along details of the user that made the interaction. In this example the metric key would be `flashcards-flipped`: - If I ask for a feature Trophy does not support, do not implement a workaround. - Instead, tell me it's not currently supported and ask me to contact Trophy support at support@trophy.so to submit a feature request. + - Keep changes production-minded: - - Follow existing architecture and naming conventions. - - Handle API failures gracefully. - - Return a clear list of changed files and manual verification steps. - + By making this call, you're telling Trophy that a specific user made an interaction with your product. As a result, Trophy will process any gamification features like achievements or streaks that you've configured against the metric automatically. - For ideas on what to build next, explore: + + + With a metric integrated into your backend, you're ready to start adding gamification features to your product. + + Follow the links below to learn more about each feature you can build with Trophy: @@ -339,6 +266,7 @@ Here you'll integrate your backend web application with Trophy and start buildin Or, explore our [API reference](/api-reference/introduction) to get familiar with what Trophy can do. + diff --git a/i18n.json b/i18n.json index e5c21728..780bc44f 100644 --- a/i18n.json +++ b/i18n.json @@ -37,7 +37,10 @@ "webhooks/events/leaderboards/*.mdx", "webhooks/events/points/*.mdx", "webhooks/events/streaks/*.mdx", - "uikit/*.mdx" + "uikit/*.mdx", + "mcp/*.mdx", + "mcp/account-mcp-server/*.mdx", + "mcp/docs-mcp-server/*.mdx" ], "exclude": [ "snippets/*.mdx", diff --git a/i18n.lock b/i18n.lock index ffc370cb..6713fd6f 100644 --- a/i18n.lock +++ b/i18n.lock @@ -472,66 +472,52 @@ checksums: meta/description: 2e4b53d1f513ed4b0baf43b3e03c50d0 meta/og%3Adescription: 0c31ff8357910c4566c5444ba7ec2d9a content/0: 6e422a40926769a70977ec8760d8678a - content/1: babb88ff68c2b9d3eef53fa4ade50088 - content/2: ec83b8be6d912b1234ffbc9f09f4ff05 - content/3: cdd33bc655b03bcba0b69e783340ec53 - content/4: 3d6c6c4f9855a8cf2f9d5f591b6c52df - content/5: f74b0afb330a295bb50103c7b2063e69 - content/6: 0048a761c5e2e672081222f23b20c716 - content/7: 3c5ab0cfa0a2b998885ff412132eb7ab - content/8: cd1c91d062a27881a798e92f1e239199 - content/9: 62bee6c8ee296a5be9c50b624827e7e7 - content/10: d06b3bc7b41c515df4deddc588e68420 - content/11: b02bef6aff19ed15bcf486b2974c2551 - content/12: ffe743c95b7b36efc1ff57bce471ad82 - content/13: 00b82b76758da5447270141518cdd41c - content/14: dffb591a41a53b1baaa93e10c333afef - content/15: 9a227656a512c5a79fc25ce848ebf163 - content/16: 67b49c25a88dfb4a006ae21c0e23ede7 - content/17: a69085aaa46c9b99c79ca3266d228e00 - content/18: f3931e5548f073249acc2b79e7972bf8 - content/19: 2e43465d0cd62f76e82df405620d29b6 - content/20: 2de31ce64ae2ec0643e35b5d4f3794d7 - content/21: c7293817039526172227474b477af24f - content/22: c4f2237a5b7f6bdc10bcbb71409980ae - content/23: 531d7a02d64d00b7421254744a2480b1 - content/24: cd99ee12ffd6f6bcf8a702a4909f1972 - content/25: fc2f7dbd7f5af136c2b9b706db387410 - content/26: 9f7d704655d6054f2ebd52da64a1c760 - content/27: a664e8ae8a77b49981495c752e680f7d - content/28: ab951ba5533e9c68e789c42bb48a2c36 - content/29: da5a5b2fdae4c8cca772d6dd77a1d99f - content/30: 296ec9090882ae655fd6fb11d18d6824 - content/31: 21742d74f28887a4c9001f4f6f587a81 - content/32: fdc368df04e3007ce730f38f1490a9b9 - content/33: 589f66723b9cc5fe6fd2af359597296d - content/34: 5579e48d381bbe05eb460f2611b99ae7 - content/35: 143e689ab4d5ffff7bc5e4a33af55685 - content/36: fdc368df04e3007ce730f38f1490a9b9 - content/37: 589f66723b9cc5fe6fd2af359597296d - content/38: 632d4ebc0b716e4361dfaa976a4bfd67 - content/39: 152ee5e36b0e32c36b0bc07572b1bea4 - content/40: fdc368df04e3007ce730f38f1490a9b9 - content/41: 589f66723b9cc5fe6fd2af359597296d - content/42: afd6ab10651a820d051920d617dd010b - content/43: cf4f06c5f179e0518445186762238fb0 - content/44: a9750e31c995086a047544aac4f69b8b - content/45: f43461ee3f1e455c83c3463488f5ea8c - content/46: f6f75d2cf6ea2fa8587e9c050a17a0f7 - content/47: ba903d08fe21291f7de673c8efdeb8a5 - content/48: 39869860e06375a53507816702e25894 - content/49: 673b1581199af42481abd365bc499274 - content/50: 7786c528b0fe8ddff35b7e1ea9132458 - content/51: 7b18b460193604289c3a692342a44fb2 - content/52: 58e6eca0de1e31ef7585b4f9b0d0b951 - content/53: 30d8c07c0158ac1190f28b9068684c5b - content/54: 27718fbe349c9723c83a1bc0268f625d - content/55: 8cd8795d20c8b4ecb4adf2f1986cfe28 - content/56: 6c56ce6270996a6da36a63551094929f - content/57: 2de31ce64ae2ec0643e35b5d4f3794d7 - content/58: 876449849f4776edd4b50d5bb1bc11cc - content/59: 10e8e9a59847ddd720c6d06b12c7b120 - content/60: 9799b973234bf2d10d5c971b267f55a5 + content/1: f8e9ee9e70d3979a06b50feb6cbdd428 + content/2: f41c18219e00643e5cdb8123c1752ee7 + content/3: 531d7a02d64d00b7421254744a2480b1 + content/4: cd99ee12ffd6f6bcf8a702a4909f1972 + content/5: 65e0af85cbb23ca135e56262618df8f1 + content/6: 7194831cc883248bdc9921d9167b24b7 + content/7: db8686b88c881fda7b9377ebdeefb72a + content/8: b5cacd3351b153d07d9bf73adc18c9a0 + content/9: cf4f06c5f179e0518445186762238fb0 + content/10: f193a085ab60e0de7501771845fa064f + content/11: f43461ee3f1e455c83c3463488f5ea8c + content/12: b35b6dd260cd44c811622aed2c307fdd + content/13: ba903d08fe21291f7de673c8efdeb8a5 + content/14: 39869860e06375a53507816702e25894 + content/15: 673b1581199af42481abd365bc499274 + content/16: 7786c528b0fe8ddff35b7e1ea9132458 + content/17: b5df985278461b30f022adf43dc9751e + content/18: a65b3ee44e8f20c7fab2e89360391902 + content/19: 57ac8b56cbe1fe24ff5978a2e140a1f8 + content/20: 27718fbe349c9723c83a1bc0268f625d + content/21: 8cd8795d20c8b4ecb4adf2f1986cfe28 + content/22: 6c56ce6270996a6da36a63551094929f + content/23: 2de31ce64ae2ec0643e35b5d4f3794d7 + content/24: 0a020a22234cd5a8c4409f87dd74a4c4 + content/25: cdd33bc655b03bcba0b69e783340ec53 + content/26: 3d6c6c4f9855a8cf2f9d5f591b6c52df + content/27: f74b0afb330a295bb50103c7b2063e69 + content/28: 0048a761c5e2e672081222f23b20c716 + content/29: 3c5ab0cfa0a2b998885ff412132eb7ab + content/30: cd1c91d062a27881a798e92f1e239199 + content/31: 62bee6c8ee296a5be9c50b624827e7e7 + content/32: d06b3bc7b41c515df4deddc588e68420 + content/33: b02bef6aff19ed15bcf486b2974c2551 + content/34: ffe743c95b7b36efc1ff57bce471ad82 + content/35: 00b82b76758da5447270141518cdd41c + content/36: dffb591a41a53b1baaa93e10c333afef + content/37: 9a227656a512c5a79fc25ce848ebf163 + content/38: 67b49c25a88dfb4a006ae21c0e23ede7 + content/39: a69085aaa46c9b99c79ca3266d228e00 + content/40: f3931e5548f073249acc2b79e7972bf8 + content/41: 2e43465d0cd62f76e82df405620d29b6 + content/42: 2de31ce64ae2ec0643e35b5d4f3794d7 + content/43: c7293817039526172227474b477af24f + content/44: ff7d593434f7d8110b39a5b55748f428 + content/45: 10e8e9a59847ddd720c6d06b12c7b120 + content/46: 9799b973234bf2d10d5c971b267f55a5 953868115d4c9e608173a3be973757d5: meta/title: f48ab602c5c8031afd2de550b2778bf0 meta/description: e25074e52204f7c87fd6279e356af78d @@ -6806,3 +6792,223 @@ checksums: content/0: c3d96e3528a55b20b8fbcae10af25b02 content/1: 264d832bc605beaf5168c080bfed567c content/2: 580af53aa9812f2ec29a632e145669a5 + 5f1f2300ee3e735f8ffc83f5fa88bebb: + meta/title: 30c54e4dc4ce599b87d94be34a8617f5 + meta/description: cda96a6e2e9a1ce2076d08326ac53fc5 + meta/og%3Adescription: cda96a6e2e9a1ce2076d08326ac53fc5 + content/0: e849ca49817bb15e1b8311fffc43415c + content/1: 3606ef489b1f1ddb964bd2656575779e + content/2: fbe9b877947d5a1ae45d7293859e79bb + content/3: 74f931e2dd9e2b7769a1bc79166f0c55 + content/4: a2ee593912ce453b4c6ad62ad3d7a78c + content/5: 6d54b131a2544371996222345567cdcc + content/6: f9fc59ec8617ba4e7dce7f9dde298c6c + content/7: f634c17032b4c1f1a8ec3b0b86ec2f1a + content/8: e70cffc79c3cf4864ab00b2e93a52d0d + content/9: 10e8e9a59847ddd720c6d06b12c7b120 + content/10: 9799b973234bf2d10d5c971b267f55a5 + cfa8c4b1fe4edb736777252f2f2c7886: + meta/title: fb113387b7ee8d5f097359edc1c5f22d + meta/description: a900b2a47394d64994fa0e1f999cacc2 + meta/og%3Adescription: a900b2a47394d64994fa0e1f999cacc2 + content/0: d59f46137fceced954670bfc46c72889 + content/1: 7b7f8ff6b0f47bbe5e56a1fb3f46f3fa + content/2: e84f0d51780bee5e538f0726bf14a11a + content/3: 5dbd45303d238f8b325164bb52da22a4 + content/4: bf106981506d89330e58d20fc1e08c5d + content/5: d5a87a0356f9ab87e5a9aef4e2c9da7a + content/6: 0bf85ceeccbe02b49ada225cf69f0480 + content/7: b8d5f895e373288ac1796d83959bfe8f + content/8: f44982b2ea6be0c6baec0c90d1a03592 + content/9: b103472955c8efd67ac4ccfc4f82f847 + content/10: c36fa0510464dd2605685ce280fd4d43 + content/11: b3cbec3c00ea5370b81bad25e2a3b299 + content/12: aa9a94c8a23d322f8db232da1c3dd000 + content/13: 2660992cb63cc07c3a75b1350b2dca78 + content/14: e12165b2e66d44e72cd1469ba22a9046 + content/15: 8c3834e1145d3ef724b09dc54f13acfa + content/16: ef791342ea3753574b9dd35a1d5a65a4 + content/17: 606d151c729292648d586f56a8bc19ff + content/18: c8efb2a18ef396f55703ccc9f886e7ce + content/19: e367954c11539421df00a7418a3c76ef + content/20: 10e8e9a59847ddd720c6d06b12c7b120 + content/21: 9799b973234bf2d10d5c971b267f55a5 + 22704a4b6dd5624589624c90bf484785: + meta/title: 439cb79e8dfd7923d35b85cfbb6fd201 + meta/description: 82c83d88a6368143110faf1302029a76 + meta/subtitle: 19b34186cda38b28f57ff47514306414 + content/0: 67f3581dcb17b15abeb35cbe4276414b + content/1: 8af5e8b96cb8fb79e029abcc2ee499e6 + content/2: 998380eb2ca953e360599d07a077e5ac + content/3: 2c2804834d2b5bb1864a4c0bead8a123 + content/4: edf41ec1aa37f0ad9a0bb62ff915b439 + content/5: 1912e21534893fae57c9123218cd7c2a + content/6: 3f7a2e94b3971e2d24d332076d673475 + content/7: 2d66ff151378efdf064b2c7065866e44 + content/8: 4dbd81c88de2273aaa12ab8e0294765a + content/9: 839bd034255a2a23d49c972f402d243e + content/10: 56bf739dd893db8de60e998aab963c1e + content/11: 643eddb9a6d5582db7a57caf0016d00e + content/12: 894331d40abb73ee47109ed45fd1e3c5 + content/13: 661e97346571e3f16d7b8aaf91b7be9f + content/14: a1ec0d0cf898e52f83fc6592288b5f6d + content/15: 10e8e9a59847ddd720c6d06b12c7b120 + content/16: 9799b973234bf2d10d5c971b267f55a5 + 0900c9b2199247a6492b628a4be26fa9: + meta/title: 70aaaea59e0186b1d4e2b175b26e4489 + meta/description: 0e9e0ce326e91df1c611a4626c153d69 + meta/subtitle: 588ce575ba06367cc778d1173092d46a + meta/icon: f1a858d3c437c534103d95a3baac5387 + content/0: b5f684a6be27a02965539795a839110d + content/1: e999933c9639a63c76d98da42e8d5c84 + content/2: 998380eb2ca953e360599d07a077e5ac + content/3: 34bc06e13023f063e414bece893eb029 + content/4: 9048ff005574830ea36d68c53074efdd + content/5: 820ff390b42931704ae81fbb95766b79 + content/6: b118ea2d7a06047926446fbeadfb6b7a + content/7: 6ee3cb0b4d92706090805881144d4bc7 + content/8: a7cc7fd0d7f4a4721ac555e930e4000d + content/9: e3f54f13da95a462283037d91efef43d + content/10: d78ff9b6e2c64fac9bbc99c1495b88b0 + content/11: 050838514f7d27366e758ea5bb7908f3 + content/12: d4223773ecc411ed5737f0aebd8aad4c + content/13: 6cc9f99481aa257403295d038d866e07 + content/14: ac9316d12802d40bfc8b837408556ac9 + content/15: ed2e41d05d1577a7e253ebbabea7da47 + content/16: 767ba153cc987948beff67c89a01b3a1 + content/17: a7254c770fd1175546824fda86a8b1c5 + content/18: f549c7d1fd2ccd020fbd874cf5d810a8 + content/19: 7459a559b0a8fcda7b8057706d198d47 + content/20: aabbde919ead607efb744bec81f374af + content/21: 3faca056dffc8c3fa2923fa487338f00 + content/22: 3304a33dfb626c6e2267c062e8956a9d + content/23: 0c9e0331453317905cbbdb10fdd9ee19 + content/24: 4c76a31f0259dc7749d33379a585822b + content/25: e1041a0f052cff7e363a92a13ccdfb46 + content/26: c3d474432986c8a6cd2d5c171d5d6b6b + content/27: a40e1779367f7b682a6167acd0bd7ed5 + content/28: 7b0c8f561f2d5e3655bf9251509a8946 + content/29: 4c7e32bd88a25ab0e1906200914d16d3 + content/30: 10e8e9a59847ddd720c6d06b12c7b120 + content/31: 9799b973234bf2d10d5c971b267f55a5 + 9ffb422e2af788f84baa1b654718550a: + meta/title: fd27a0028b8e4b31e39c77814f2bd47a + meta/description: d259b3e6928b7d88c1dbb64c977c4a43 + meta/og%3Adescription: d259b3e6928b7d88c1dbb64c977c4a43 + meta/icon: 6d614c8f5f6ed003e80b91204c18d6cc + content/0: 2b2564c75024053e56183cb27f8be520 + content/1: a6442a73d2b4fac4341adea7a56d746d + content/2: 6ad2f0783caa2c9b2acf75e16d8628cc + content/3: f5b2e37d277fa26544523c987ea8923f + content/4: 3fb874d8a7837f7831623b29cefecf82 + content/5: 185d03a3079c717c27e2e5634836a799 + content/6: 5744d4bc190dc49b5db047f315582a75 + content/7: 3264a1711449028a91043a9e81fe6e50 + content/8: bd85affdaf880752aeeb4cf3d36dba8d + content/9: d08c6b327fb9446834b3d818b091da0b + content/10: bad5608458ad8bbf16941c7b6d8a14af + content/11: d44673d90f526f8ee29de4a5e8bdfc1d + content/12: 2181c5e4996dfd51484bfa3dea32a94e + content/13: bce5d145cec217d9b7f644627b7b6a1b + content/14: db6d24914c1de085e26560370be977c9 + content/15: 4e267161a4c8ecfb8f604824fc032fa3 + content/16: 0180c590de0eb6e3092150025addc201 + content/17: c3b7e444bfe4ba4de2a4ebb338a99783 + content/18: 906326b6e07826e34997c7e74858b04b + content/19: 431a61acda15a142344c3cac80215f1c + content/20: 16bbbb68d323e2659d94d52164b12213 + content/21: be143a49b206d2248b9e98b5b3f15ad5 + content/22: 30013b95bd839ef992b233407dcfef82 + content/23: df2706de4f3315b291837446b0d7c0d6 + content/24: c98b6438d30b43ed6f280cef4cb1692c + content/25: 933b2903effb251282d947f941b63f3c + content/26: 419d6be21d20157b54608511f2dfe724 + content/27: 8f7ce9f2e1e54867eacd4e6db981a84e + content/28: 1df98519caec0282fe7b984ffd11efb9 + content/29: a99d6101e30525bbeaecd8141f4f73d3 + content/30: 10e8e9a59847ddd720c6d06b12c7b120 + content/31: 9799b973234bf2d10d5c971b267f55a5 + 8526e0bfc63d38ab4ff24fc5b4332813: + meta/title: 439cb79e8dfd7923d35b85cfbb6fd201 + meta/description: 9a92512ff148e565070ea4b09bc7bd0f + meta/subtitle: 6ecd696b3888ceca5fa7143c4102cceb + content/0: 93672ad22395b1fb71418bb00a3efc8c + content/1: 5a51534cac25fd4e9346e65f8be927b5 + content/2: cb9c7ced6d250c33886b01c49a6266da + content/3: d3bc84e24fa3be41c6d5accb7736916c + content/4: 6bd1a231b69b0b1f8abdc997ee860f38 + content/5: 7177d23a12c7648f25971bf293e2234f + content/6: 32265055614e9efb76f952eb84fef4b7 + content/7: b0c85be748569624e4561514ea70ed04 + content/8: 839bd034255a2a23d49c972f402d243e + content/9: 39d09c3b28a0fd221127c9bd7230c438 + content/10: 54ae8678f510b70e2702c7ab0a67fb11 + content/11: 27cca54dca32acee7a86846d030d3178 + content/12: 661e97346571e3f16d7b8aaf91b7be9f + content/13: 59e8dbc167a30497e7405ed086521c5f + content/14: 10e8e9a59847ddd720c6d06b12c7b120 + content/15: 9799b973234bf2d10d5c971b267f55a5 + 44d82bac2aac529d19fe3b83263f921c: + meta/title: 70aaaea59e0186b1d4e2b175b26e4489 + meta/description: b8b828dee9e66fb05e58cad976e65929 + meta/subtitle: 0944b4801798a716b484a5211d5969d4 + meta/icon: f1a858d3c437c534103d95a3baac5387 + content/0: 15b9d73b2a3881d6cad11d6fb80058bc + content/1: cb9c7ced6d250c33886b01c49a6266da + content/2: 65c23e88d92863131bcb3eea94dab177 + content/3: 34bc06e13023f063e414bece893eb029 + content/4: 720557efb8842a99afcddb56c76bc62f + content/5: 7951bbc184556693ccb15339d14abd59 + content/6: d1af51c143875bdf4c74396a0c442078 + content/7: 2114df474a78b2346981749b2eecf0cd + content/8: 050838514f7d27366e758ea5bb7908f3 + content/9: d4223773ecc411ed5737f0aebd8aad4c + content/10: 7762bf280ba119b8fc1d595e925ece30 + content/11: d5e9647b46f17c4ddb6d651e2893531b + content/12: 00abf293ba852aad574dec8a72de2e16 + content/13: dcd7495f7b848ba754bdb5f0e94cbb8e + content/14: 7459a559b0a8fcda7b8057706d198d47 + content/15: ca2e51df4430012a42662836f41ab58a + content/16: 9b8f2c76b263d81927bbb27b53209e39 + content/17: 0c9e0331453317905cbbdb10fdd9ee19 + content/18: 327d8727fe5c29a1acf99ac744ffe2bb + content/19: e12b0f25346d8297d1551d971f8bf06a + content/20: ed0fc64a638b99613a41aabc349c79b5 + content/21: 7b0c8f561f2d5e3655bf9251509a8946 + content/22: db38c4ea813ac1c53809a46a8849fd48 + content/23: 10e8e9a59847ddd720c6d06b12c7b120 + content/24: 9799b973234bf2d10d5c971b267f55a5 + db1e54d03d8ae1480f140044c10ec66c: + meta/title: fd27a0028b8e4b31e39c77814f2bd47a + meta/description: e9869324a2f9cb0488156e00647a7d06 + meta/og%3Adescription: e9869324a2f9cb0488156e00647a7d06 + meta/icon: 6d614c8f5f6ed003e80b91204c18d6cc + content/0: 2b58f31a0df18278b66e0ccaef2704c7 + content/1: a13828c1a173ca2da416b1fbd3e61a65 + content/2: 17e2243944617afb05343d1f40f2e674 + content/3: 20e26e0f6f2e90a31a89f7208bb342eb + content/4: 3e7cb0e026f811dca49bd0eb4f57cf4a + content/5: 8b0528f47e0bd91e6ddd7b9a1f609b94 + content/6: 69192b28aec067efa34eec763c7faefc + content/7: a0455c1cf77bf7bb6c933d1d4d2e1381 + content/8: 2c6cf9ff266267d5ae0bca0b56b2f227 + content/9: 8684fed8d76d1d591b69e12fedd61036 + content/10: ee1fb86053a93a19858590ab06792e9a + content/11: 84e10ef4fbeea64f170251d5c7fb8a66 + content/12: 99309af6f486e0a6e479344c502e50ff + content/13: 3e7cb0e026f811dca49bd0eb4f57cf4a + content/14: 113932b3a7cd8aa536e77cc5801f3b53 + content/15: a96c03581a321f444cc4e5e4a436b6e4 + content/16: 9e334f8c4df63e4cb1219d9ba34861ce + content/17: 032b61f24e420302380a6307f7203c7c + content/18: 16cf05caba8d1e09cc172dc1abaa74b2 + content/19: 78f7744688591e94771314bdb94dc02f + content/20: 7959201019ca4b923b708471569d935f + content/21: 0b704a7e827b1e8b7b4a4cca2773bd4c + content/22: cdaaccfac2d7072e35f83c3be595c934 + content/23: 6028b921d2bc6d0b403f78a93593291d + content/24: c699f3ad9cdea78ffc3be458c472191e + content/25: 7b0c8f561f2d5e3655bf9251509a8946 + content/26: e815c435234e61991573554f3b017fe1 + content/27: 10e8e9a59847ddd720c6d06b12c7b120 + content/28: 9799b973234bf2d10d5c971b267f55a5 diff --git a/icons/mcp.svg b/icons/mcp.svg new file mode 100644 index 00000000..a5f60dea --- /dev/null +++ b/icons/mcp.svg @@ -0,0 +1,6 @@ + + + diff --git a/mcp/account-mcp-server/capabilities.mdx b/mcp/account-mcp-server/capabilities.mdx new file mode 100644 index 00000000..e85d1ef4 --- /dev/null +++ b/mcp/account-mcp-server/capabilities.mdx @@ -0,0 +1,107 @@ +--- +title: Capabilities +description: Learn about what the Trophy Account MCP Server can do. +og:description: Learn about what the Trophy Account MCP Server can do. +icon: wrench +--- + +Once connected, the Account MCP Server exposes tools your agent can call to inspect and manage your account. + +Most resources offer paired **read** and **write** tools: + +- **Read** tools list and fetch resources +- **Write** tools create or update resources in batch to speed up operations + +## Metrics Tools {#metrics-tools} + +Create and manage the [Metrics](/features/metrics) that drive streaks, achievements, points, and leaderboards. + +| Tool | What it does | +| --- | --- | +| `read_metrics` | List metrics, or get a single metric by ID | +| `write_metrics` | Create or update metrics | + +## Attributes Tools {#attributes-tools} + +Manage [custom user attributes](/features/users#custom-user-attributes) and [custom event attributes](/features/events#custom-event-attributes) used for feature targeting and personalization. + +| Tool | What it does | +| --- | --- | +| `read_attributes` | List attributes, or get a single attribute by ID | +| `write_attributes` | Create or update attributes | + +## Leaderboards Tools {#leaderboards-tools} + +Configure [Leaderboards](/features/leaderboards) within your Trophy account. + +| Tool | What it does | +| --- | --- | +| `read_leaderboards` | List leaderboards, or get a single leaderboard by ID | +| `write_leaderboards` | Create or update leaderboards | + +## Points Tools {#points-tools} + +Configure full [Points](/features/points) systems, including [Triggers](/features/points#points-triggers), [Levels](/features/points#points-levels), and [Boosts](/features/points#points-boosts). + +| Tool | What it does | +| --- | --- | +| `read_points_systems` | List points systems, or get one by ID | +| `write_points_systems` | Create or update points systems (optionally with nested triggers, levels, and boosts) | +| `read_points_triggers` | List or get triggers for a points system | +| `write_points_triggers` | Create or update triggers for a points system | +| `read_points_levels` | List or get levels for a points system | +| `write_points_levels` | Create or update levels for a points system | +| `read_points_boosts` | List or get boosts for a points system | +| `write_points_boosts` | Create or update boosts for a points system | + +## Tenants Tools {#tenants-tools} + +Manage [multi-tenant](/platform/multi-tenancy) organization records when multi-tenancy is enabled on your account. + +| Tool | What it does | +| --- | --- | +| `read_tenants` | List tenants, or get a single tenant by ID | +| `write_tenants` | Create or update tenants | + + +If multi-tenancy is not enabled on your account, these tools will not function. + + +## Streaks Tools {#streaks-tools} + +Run operational [streak](/features/streaks) actions for users, such as granting [streak freezes](/features/streaks#streak-freezes) or [restoring streaks](/features/streaks#restoring-a-users-streak). + +| Tool | What it does | +| --- | --- | +| `grant_streak_freezes` | Grant streak freezes to one or more users | +| `restore_streaks` | Restore a broken streak to it's previous length | + +## Example Prompts {#example-prompts} + +Use natural language — your agent picks the right tool and parameters: + +```text +Create an XP system called 'Kudos' that grants 10 points for each workout completed. +``` + +```text +Schedule 2X XP boosts for the 'Kudos' system across the next 3 weekends (only for paying users - 'plan' attribute is 'pro'). +``` + +```text +Grant two streak freezes to user user_123. +``` + +```text +user_123 wants their streak back, restore it to it's previous length. +``` + +## Scope and Safety {#scope-and-safety} + +- Tools will only act on the Trophy [environment](/platform/environments) tied to the API key you pass in `x-trophy-api-key`. +- Write tools can change live configuration. Prefer a staging or sandbox [environment](/platform/environments) when iterating. +- Tools cannot delete resources. + +## Get Support {#get-support} + +Want to get in touch with the Trophy team? Reach out to us via [email](mailto:support@trophy.so). We're here to help! diff --git a/mcp/account-mcp-server/installation.mdx b/mcp/account-mcp-server/installation.mdx new file mode 100644 index 00000000..c9e67ce0 --- /dev/null +++ b/mcp/account-mcp-server/installation.mdx @@ -0,0 +1,162 @@ +--- +title: Installation +description: Install the Account MCP Server in Claude Code, Cursor, VS Code, and other MCP clients. +subtitle: Connect the remote Account MCP Server to your coding agent. +icon: download +--- + + + You need a [Trophy account](https://app.trophy.so/sign-up) to use the Trophy Account MCP Server. + + +The Trophy Account MCP Server is a remote HTTP MCP server. You point your client at the URL below using your [Admin API key](/admin-api/authentication) and your agent can start using the tools. + +```bash Server URL +https://mcp.trophy.so +``` + +## Install in Your Client {#install-in-your-client} + +Name this server clearly (for example `Trophy Account`) so it does not collide with the [Docs MCP Server](/mcp/docs-mcp-server/installation). + + + Replace `YOUR_ADMIN_API_KEY` with an API key from the [integrations page](https://app.trophy.so/integration) of the Trophy dashboard. + + + + + Add the remote server with a `headers` entry for the API key: + + ```bash + claude mcp add-json "Trophy Account" '{ + "type": "http", + "url": "https://mcp.trophy.so", + "headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" + } + }' + ``` + + To pull the key from the environment instead of inlining it: + + ```bash + claude mcp add-json "Trophy Account" "{ + \"type\": \"http\", + \"url\": \"https://mcp.trophy.so\", + \"headers\": { + \"x-trophy-api-key\": \"${TROPHY_API_KEY}\" + } + }" + ``` + + Verify it appears in your list: + + ```bash + claude mcp list + ``` + + + Open MCP settings and add this to your `mcp.json`: + + ```json + { + "mcpServers": { + "Trophy Account": { + "url": "https://mcp.trophy.so", + "headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" + } + } + } + } + ``` + + If you prefer not to store the key in the file, use Cursor’s env substitution where available: + + ```json + { + "mcpServers": { + "Trophy Account": { + "url": "https://mcp.trophy.so", + "headers": { + "x-trophy-api-key": "${env:TROPHY_API_KEY}" + } + } + } + } + ``` + + Restart Cursor if needed so the server and headers load. + + + Create or update `.vscode/mcp.json` in your workspace: + + ```json + { + "servers": { + "Trophy Account": { + "type": "http", + "url": "https://mcp.trophy.so", + "headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" + } + } + } + } + ``` + + Reload VS Code and enable the server. + + + Any MCP client that supports remote HTTP servers and a `headers` config can connect. + + Use: + + - **Transport:** HTTP (streamable HTTP) + - **URL:** `https://mcp.trophy.so` + - **Name:** `Trophy Account` (or any label you prefer) + - **headers:** + + ```json + { + "headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" + } + } + ``` + + + +## Verify the Connection {#verify-the-connection} + +Ask your agent something that requires a live account call, for example: + +```text +List the metrics in my Trophy account. +``` + +If authentication succeeded, you should get metrics from your organization. If you get an auth or unauthorized error, confirm the key is valid and that your client’s config includes: + +```json +"headers": { + "x-trophy-api-key": "YOUR_ADMIN_API_KEY" +} +``` + +## Next Steps {#next-steps} + + + + Explore what tools the Account MCP Server exposes. + + + Add on-demand docs context for your agent. + + + Recommended ways to work with agents and MCP. + + + +## Get Support {#get-support} + +Want to get in touch with the Trophy team? Reach out to us via [email](mailto:support@trophy.so). We're here to help! diff --git a/mcp/account-mcp-server/introduction.mdx b/mcp/account-mcp-server/introduction.mdx new file mode 100644 index 00000000..a409d0a8 --- /dev/null +++ b/mcp/account-mcp-server/introduction.mdx @@ -0,0 +1,55 @@ +--- +title: Introduction +description: Learn about the Account MCP Server and why it exists for AI agents. +subtitle: Give AI agents secure, structured access to your Trophy account. +--- + +The Account MCP Server is a remote [Model Context Protocol](https://modelcontextprotocol.io) server that lets AI agents read and manage gamification configuration in your Trophy account. + +Instead of copy-pasting dashboard clicks into chat, you can ask your agent to inspect metrics, create points systems, update leaderboards, restore streaks, and more. + +```bash Server URL +https://mcp.trophy.so +``` + +## Why the Account MCP? {#why-the-account-mcp} + +AI coding agents are already where teams design and ship product work and Trophy has simplified this by providing pre-built infrastructure for building common gamification features. However this largely involves looking at screens and clicking buttons. + +The Account MCP Server is the **action layer**: after the agent understands *what* to build (often via the [Docs MCP Server](/mcp/docs-mcp-server/introduction)), it can discover live account configuration, make targeted changes, and validate results without a human touching the dashboard. + +This opens up a new workflow for teams where agents can reason about what gamification features to build, understand how to map that to Trophy features, and configure a Trophy account that acheives this all within chat. + +Typical workflows include: + +- Scaffolding metrics, attributes, and points systems while integrating Trophy into a new app +- Inspecting existing leaderboards or points configuration before changing production code +- Running operational tasks like granting freezes or restoring streaks from chat + +## How It Works {#how-it-works} + +Trophy hosts a remote MCP endpoint. You install it once in your MCP client, authenticate with an admin API key from the [integrations page](https://app.trophy.so/integration) under a `headers` config (`x-trophy-api-key`), and the client exposes tools your agent can call. + +Those tools map to account operations — list/get for discovery, create/update for configuration, and dedicated actions for streak freezes, restores and reading analytics. + + + The Account MCP Server is intended for chat-based and agent workflows. For scripts, backend jobs, or production integrations, use the [Admin API](/admin-api/introduction). + + +## Get Started {#get-started} + + + + Connect the MCP server in Claude, Cursor, VS Code, and other clients. + + + See the tools your agent can use once connected. + + + Recommended ways to work with agents and MCP. + + + +## Get Support {#get-support} + +Want to get in touch with the Trophy team? Reach out to us via [email](mailto:support@trophy.so). We're here to help! diff --git a/mcp/best-practice.mdx b/mcp/best-practice.mdx new file mode 100644 index 00000000..7a79e3e4 --- /dev/null +++ b/mcp/best-practice.mdx @@ -0,0 +1,65 @@ +--- +title: Best Practice +description: How to use Trophy’s Docs MCP and Account MCP servers together. +og:description: How to use Trophy’s Docs MCP and Account MCP servers together. +--- + +The Trophy Docs MCP Server and Account MCP Server are designed to be used together. This page covers the recommended ways to use them. + +## Using Both Servers Together {#using-both-servers-together} + +Install both servers in your MCP client using distinct names so tools stay easy to target: + +| Recommended name | URL | +| --- | --- | +| `Trophy Docs` | `https://docs.trophy.so/mcp` | +| `Trophy Account` | `https://mcp.trophy.so/mcp` | + +Installation guides: [Docs MCP](/mcp/docs-mcp-server/installation), [Account MCP](/mcp/account-mcp-server/installation). + +## Docs MCP: Live Documentation {#docs-mcp-live-documentation} + +Use the Docs MCP as live context for how Trophy works. Use it when you need to: + +- Understand the behavior of Trophy features in detail +- Brainstorm how to solve your specific gamification use case +- Find the right API to call + +The Trophy Docs MCP Server is **read-only** and always reads live public documentation, use it over local copies to ensure you have the most up-to-date information. + +See [Docs MCP capabilities](/mcp/docs-mcp-server/capabilities) for more details. + +## Account MCP: Account Configuration and Operations {#account-mcp-account-configuration-and-operations} + +Use the Account MCP when you need to take actions in your Trophy account. Use it when you need to: + +- Read configuration from your Trophy account e.g. metrics, leaderboards etc. +- Configure new or update existing resources in your Trophy account via chat. +- Complete operational tasks such as granting freezes or restoring streaks. + +Access is scoped to a specific Trophy [environment](/platform/environments) via [Admin API keys](/admin-api/authentication). + +See [Account MCP capabilities](/mcp/account-mcp-server/capabilities) for more details. + +## Recommended Workflow {#recommended-workflow} + +For most agentic Trophy work, use both servers together: + +1. **Docs MCP** — load the feature or API behavior the task needs +2. **Account MCP (read)** — list related resources so work builds on what already exists +3. **Account MCP (write)** — create or update only what the task requires +4. **Your app** — implement Application API calls in code using docs-backed shapes and your API keys +5. **Verify** — re-read account state or docs if something fails + +### Example Prompt {#example-prompt} + +```text +Using Trophy Docs MCP, review how metrics and event tracking works. +Using Trophy Account MCP, list my existing metrics. +Create a new 'workouts completed' metric if one does not already exist. +Then integrate event tracking to this metric in my code based on the docs. +``` + +## Get Support {#get-support} + +Want to get in touch with the Trophy team? Reach out to us via [email](mailto:support@trophy.so). We're here to help! diff --git a/mcp/docs-mcp-server/capabilities.mdx b/mcp/docs-mcp-server/capabilities.mdx new file mode 100644 index 00000000..fbc6ad54 --- /dev/null +++ b/mcp/docs-mcp-server/capabilities.mdx @@ -0,0 +1,91 @@ +--- +title: Capabilities +description: Learn about what the Trophy Docs MCP Server can do. +og:description: Learn about what the Trophy Docs MCP Server can do. +icon: wrench +--- + +The Trophy Docs MCP Server exposes a small set of **read-only** tools scoped to public Trophy documentation. Agents should prefer these over prior memory for Trophy-specific questions. + +## Search {#search} + +| Tool | What it does | +| --- | --- | +| `search_trophy_docs` | Semantic-style search across the docs knowledge base; returns relevant snippets, titles, and page paths | + +Use search for conceptual or “how do I…” questions — authentication, rate limits, feature behavior, integration patterns. + +Example prompts: + +```text +Search Trophy docs for how points boosts work. +``` + +```text +Find the Application API endpoint for submitting a metric event. +``` + +## Read Documentation Pages {#read-documentation-pages} + +| Tool | What it does | +| --- | --- | +| `query_docs_filesystem_trophy_docs` | Run read-only shell-style queries against a virtual filesystem of docs pages and OpenAPI specs | + +This is how the agent reads full pages once search returns a path. There is no separate “get page” tool — the agent uses commands like `head`, `cat`, `rg`, `tree`, or `ls` against paths such as `/features/streaks.mdx` or `/api-reference/introduction.mdx`. + +Common patterns: + +- `tree / -L 2` — explore docs structure +- `rg -il "rate limit" /` — exact keyword or regex matches +- `head -80 /getting-started/quickstart.mdx` — read the top of a page +- `cat /openapi/application.json | jq '...'` — inspect OpenAPI when schema detail matters + +Output is truncated per call, so good agents use targeted reads rather than dumping entire large files. + +Example prompts: + +```text +Open the streaks feature page and summarize freeze behavior. +``` + +```text +From the Application API OpenAPI, list the user endpoints. +``` + +## Feedback {#feedback} + +| Tool | What it does | +| --- | --- | +| `submit_feedback` | Report incorrect, outdated, incomplete, or confusing documentation to the Trophy docs team | + +This is for **docs content** issues (wrong example, missing step, broken explanation) — not product support or account help. + +Example prompt: + +```text +The rate limiting page example looks wrong — file docs feedback on /api-reference/rate-limiting. +``` + +## What It Does Not Do {#what-it-does-not-do} + +The Docs MCP Server cannot: + +- Access or modify resources in your Trophy organization +- Call Trophy APIs + +For account operations, install the [Account MCP Server](/mcp/account-mcp-server/capabilities). + +## Next Steps {#next-steps} + + + + Install the Account MCP Server to your MCP client. + + + Learn what the Trophy Account MCP can do. + + + +## Get Support {#get-support} + +Want to get in touch with the Trophy team? Reach out to us via [email](mailto:support@trophy.so). We're here to help! diff --git a/mcp/docs-mcp-server/installation.mdx b/mcp/docs-mcp-server/installation.mdx new file mode 100644 index 00000000..f85903f9 --- /dev/null +++ b/mcp/docs-mcp-server/installation.mdx @@ -0,0 +1,109 @@ +--- +title: Installation +description: Install the Trophy Docs MCP Server in Claude, Claude Code, Cursor, VS Code, and other MCP clients. +subtitle: Connect live Trophy documentation to your coding agent. +icon: download +--- + +The Docs MCP Server is a remote HTTP MCP server. Point your client at the URL below and your agent can search and read Trophy docs on demand. + +```bash Server URL +https://docs.trophy.so/mcp +``` + +No Trophy account is required for the Docs MCP Server, it exposes live public documentation. + +## Install in Your Client {#install-in-your-client} + +Name this server clearly (for example `Trophy Docs`) so it does not collide with the [Account MCP Server](/mcp/account-mcp-server/installation) used for account actions. + + + + 1. Open [Claude Connectors](https://claude.ai/new#settings/customize-connectors). + 2. Select **Add > Add custom connector**. + 3. Add: + - Name: `Trophy Docs` + - URL: `https://docs.trophy.so/mcp` + 4. In chat, use the plus button to enable the Trophy Docs connector. + + + Add the docs server: + + ```bash + claude mcp add --transport http "Trophy Docs" https://docs.trophy.so/mcp + ``` + + Verify: + + ```bash + claude mcp list + ``` + + + Open MCP settings and add this to your `mcp.json`: + + ```json + { + "mcpServers": { + "Trophy Docs": { + "url": "https://docs.trophy.so/mcp" + } + } + } + ``` + + You may need to restart Cursor if the server does not appear in your MCP list. + + + Create or update `.vscode/mcp.json` in your workspace: + + ```json + { + "servers": { + "Trophy Docs": { + "type": "http", + "url": "https://docs.trophy.so/mcp" + } + } + } + ``` + + Reload VS Code and enable the server. + + + Any MCP client that supports remote HTTP servers can connect. + + Use: + + - **Transport:** HTTP (streamable HTTP) + - **URL:** `https://docs.trophy.so/mcp` + - **Name:** `Trophy Docs` (recommended) + + After adding the server, enable it in the client UI if required. + + + +## Verify the Connection {#verify-the-connection} + +Ask your agent a docs-only question, for example: + +```text +Using the Trophy Docs MCP, explain how to authenticate Application API requests. +``` + +You should get an answer grounded in docs search or a specific docs page, with links back to docs.trophy.so. + +## Next Steps {#next-steps} + + + + Learn what the Docs MCP tools can do. + + + Recommended ways to work with agents and MCP. + + + +## Get Support {#get-support} + +Want to get in touch with the Trophy team? Reach out to us via [email](mailto:support@trophy.so). We're here to help! diff --git a/mcp/docs-mcp-server/introduction.mdx b/mcp/docs-mcp-server/introduction.mdx new file mode 100644 index 00000000..57212a77 --- /dev/null +++ b/mcp/docs-mcp-server/introduction.mdx @@ -0,0 +1,51 @@ +--- +title: Introduction +description: Learn about the Trophy Docs MCP Server and why agents should use it for live documentation context. +subtitle: On-demand Trophy docs for any AI coding agent. +--- + +The Trophy Docs MCP Server is a remote [Model Context Protocol](https://modelcontextprotocol.io) server that gives AI agents live access to Trophy documentation — guides, feature pages, API references, and OpenAPI specs. + +Think of it as an **on-demand skill**: instead of relying on the model's training data, your agent can search and open the same docs you read on docs.trophy.so whenever it needs accurate, up-to-date detail. + +```bash Server URL +https://docs.trophy.so/mcp +``` + +## Why a Docs MCP? {#why-a-docs-mcp} + +Trophy changes: new endpoints ship, parameters evolve, and guides get updated. Agents that only use built-in knowledge risk inventing APIs, missing constraints, or shipping integrations against outdated patterns. + +The docs MCP keeps that context current. Before integrating a feature or explaining a payload, the agent can pull the latest docs snippet or full page and work from source of truth. + +Typical uses: + +- Answer “how does X work?” from published docs before writing code +- Look up request/response shapes and auth patterns from API reference pages +- Follow feature guides (streaks, points, leaderboards) while implementing backend events +- Explore OpenAPI specs when the agent needs exact path or schema detail + +## How It Works {#how-it-works} + +Trophy hosts a remote MCP endpoint backed by the public docs site. You install it in your MCP client; the agent gets tools to **search** the knowledge base and **read** full pages from a sandboxed docs filesystem. + +The server is **read-only**. It does not access your Trophy account, mutate configuration, or call Trophy APIs. For account actions, use the [Account MCP Server](/mcp/account-mcp-server/introduction). + + + Best results come from installing **both** servers: docs for context, Account MCP for action. See [Best practice](/mcp/best-practice). + + +## Get Started {#get-started} + + + + Connect the Docs MCP Server in common clients. + + + See how search and page-read tools work. + + + +## Get Support {#get-support} + +Want to get in touch with the Trophy team? Reach out to us via [email](mailto:support@trophy.so). We're here to help! diff --git a/mcp/overview.mdx b/mcp/overview.mdx new file mode 100644 index 00000000..8fb8a7fb --- /dev/null +++ b/mcp/overview.mdx @@ -0,0 +1,45 @@ +--- +title: Overview +description: Use AI agents to build gamified product experiences with Trophy. +og:description: Use AI agents to build gamified product experiences with Trophy. +--- + + + The Trophy MCP Servers are currently in beta and are subject to change. + + +Trophy maintains two remote [Model Context Protocol](https://modelcontextprotocol.io) servers to enable AI agents like ChatGPT, Cursor and Claude to build gamified product experiences with Trophy. + +| Server | What it is for | +| --- | --- | +| [Docs MCP Server](/mcp/docs-mcp-server/introduction) | Live documentation — search guides and API reference (like an on-demand skill) | +| [Account MCP Server](/mcp/account-mcp-server/introduction) | Account actions — manage metrics, points, leaderboards, streaks, and more | + +You can use either server on its own, but best results are achieved when following [best practice](/mcp/best-practice) by using both servers together. + +## What You Can Do {#what-you-can-do} + +With agents wired to Trophy's MCP servers you can: + +- Onboard integrations faster by having coding agents read docs while writing code +- Scaffold configuration (metrics, attributes, points systems, leaderboards) using chat +- Understand user behavior by asking agents to summarize account analytics. +- Run operational tasks such as granting freezes or restoring streaks + +## Start Here {#start-here} + + + + How we recommend using Trophy MCP servers. + + + How to use the Trophy Docs MCP Server. + + + How to use the Trophy Account MCP Server. + + + +## Get Support {#get-support} + +Want to get in touch with the Trophy team? Reach out to us via [email](mailto:support@trophy.so). We're here to help! diff --git a/style.css b/style.css new file mode 100644 index 00000000..ff9f4a76 --- /dev/null +++ b/style.css @@ -0,0 +1,16 @@ +/* Mintlify renders custom path icons as , so they ignore parent tab color. + Recolor the MCP tab icon via mask + currentColor, matching Lucide nav icons. */ +a.nav-tabs-item:has(img[src*="/icons/mcp.svg"])::before { + content: ""; + display: block; + width: 1rem; + height: 1rem; + flex-shrink: 0; + background-color: currentColor; + -webkit-mask: url("/icons/mcp.svg") center / contain no-repeat; + mask: url("/icons/mcp.svg") center / contain no-repeat; +} + +a.nav-tabs-item img[src*="/icons/mcp.svg"] { + display: none; +} From 374c2f7cb5ef327ae8c151208e08545f5c2cf183 Mon Sep 17 00:00:00 2001 From: Charlie Hopkins-Brinicombe Date: Mon, 3 Aug 2026 11:13:44 +0100 Subject: [PATCH 2/4] PR review --- mcp/account-mcp-server/introduction.mdx | 2 +- styles/config/vocabularies/Trophy/accept.txt | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/mcp/account-mcp-server/introduction.mdx b/mcp/account-mcp-server/introduction.mdx index a409d0a8..b0f0d6bb 100644 --- a/mcp/account-mcp-server/introduction.mdx +++ b/mcp/account-mcp-server/introduction.mdx @@ -18,7 +18,7 @@ AI coding agents are already where teams design and ship product work and Trophy The Account MCP Server is the **action layer**: after the agent understands *what* to build (often via the [Docs MCP Server](/mcp/docs-mcp-server/introduction)), it can discover live account configuration, make targeted changes, and validate results without a human touching the dashboard. -This opens up a new workflow for teams where agents can reason about what gamification features to build, understand how to map that to Trophy features, and configure a Trophy account that acheives this all within chat. +This opens up a new workflow for teams where agents can reason about what gamification features to build, understand how to map that to Trophy features, and configure a Trophy account that achieves this all within chat. Typical workflows include: diff --git a/styles/config/vocabularies/Trophy/accept.txt b/styles/config/vocabularies/Trophy/accept.txt index dac9f7dd..7f635bcd 100644 --- a/styles/config/vocabularies/Trophy/accept.txt +++ b/styles/config/vocabularies/Trophy/accept.txt @@ -20,6 +20,8 @@ Strava grayscale localStorage shadcn +agentic +sandboxed # Markdown rich text _[\w\s]+_ From b9f7f6e7f7024c4431ccf81b5102642f2033eac5 Mon Sep 17 00:00:00 2001 From: Charlie Hopkins-Brinicombe Date: Mon, 3 Aug 2026 11:24:16 +0100 Subject: [PATCH 3/4] Lock translations --- i18n.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n.lock b/i18n.lock index 6713fd6f..2c6edd7b 100644 --- a/i18n.lock +++ b/i18n.lock @@ -6843,7 +6843,7 @@ checksums: content/3: 2c2804834d2b5bb1864a4c0bead8a123 content/4: edf41ec1aa37f0ad9a0bb62ff915b439 content/5: 1912e21534893fae57c9123218cd7c2a - content/6: 3f7a2e94b3971e2d24d332076d673475 + content/6: 8bcab53f5bedc0c28a28704e5f852592 content/7: 2d66ff151378efdf064b2c7065866e44 content/8: 4dbd81c88de2273aaa12ab8e0294765a content/9: 839bd034255a2a23d49c972f402d243e From 407bdab7f2c41dfc9179274a7a68f1431d85ac65 Mon Sep 17 00:00:00 2001 From: Charlie Hopkins-Brinicombe Date: Mon, 3 Aug 2026 11:47:00 +0100 Subject: [PATCH 4/4] Add new tools --- es/mcp/account-mcp-server/capabilities.mdx | 97 ++++++++++++++-------- i18n.lock | 69 ++++++++------- mcp/account-mcp-server/capabilities.mdx | 59 +++++++++---- 3 files changed, 148 insertions(+), 77 deletions(-) diff --git a/es/mcp/account-mcp-server/capabilities.mdx b/es/mcp/account-mcp-server/capabilities.mdx index 9dd588c1..b5020328 100644 --- a/es/mcp/account-mcp-server/capabilities.mdx +++ b/es/mcp/account-mcp-server/capabilities.mdx @@ -7,78 +7,93 @@ icon: wrench Una vez conectado, el servidor MCP de Account expone herramientas que tu agente puede llamar para inspeccionar y gestionar tu cuenta. -La mayoría de los recursos ofrecen herramientas de **lectura** y **escritura** emparejadas: +La mayoría de los recursos de configuración ofrecen herramientas de **lectura** y **escritura** emparejadas: - Las herramientas de **lectura** listan y obtienen recursos - Las herramientas de **escritura** crean o actualizan recursos por lotes para acelerar las operaciones -## Herramientas de Métricas {#metrics-tools} +## Referencia de herramientas {#tool-reference} + +La lista completa de herramientas disponibles en el servidor MCP de Trophy Account. + +### Herramientas de Métricas {#metrics-tools} Crea y gestiona las [Métricas](/es/features/metrics) que impulsan rachas, logros, puntos y clasificaciones. | Herramienta | Qué hace | | --- | --- | -| `read_metrics` | Lista métricas u obtiene una sola métrica por ID | +| `read_metrics` | Lista métricas u obtiene una métrica específica por ID | | `write_metrics` | Crea o actualiza métricas | -## Herramientas de Atributos {#attributes-tools} +### Herramientas de atributos {#attributes-tools} -Gestiona [atributos de usuario personalizados](/es/features/users#custom-user-attributes) y [atributos de evento personalizados](/es/features/events#custom-event-attributes) utilizados para la segmentación de funciones y personalización. +Gestiona [atributos de usuario personalizados](/es/features/users#custom-user-attributes) y [atributos de eventos personalizados](/es/features/events#custom-event-attributes) utilizados para segmentación de funcionalidades y personalización. | Herramienta | Qué hace | | --- | --- | -| `read_attributes` | Lista atributos u obtiene un solo atributo por ID | +| `read_attributes` | Lista atributos u obtiene un atributo específico por ID | | `write_attributes` | Crea o actualiza atributos | -## Herramientas de Clasificaciones {#leaderboards-tools} +### Herramientas de Logros {#achievements-tools} + +Lee [Logros](/es/features/achievements) y analíticas de finalización de tu cuenta. + +| Herramienta | Qué hace | +| --- | --- | +| `read_achievements` | Lista logros con conteos de finalización y rareza; opcionalmente filtra por `user_attributes` | + +### Herramientas de Clasificaciones {#leaderboards-tools} -Configura [Clasificaciones](/es/features/leaderboards) dentro de tu cuenta de Trophy. +Configura [Clasificaciones](/es/features/leaderboards) y lee rankings en vivo. | Herramienta | Qué hace | | --- | --- | -| `read_leaderboards` | Lista clasificaciones u obtiene una sola clasificación por ID | +| `read_leaderboards` | Lista clasificaciones u obtiene una clasificación específica por ID | | `write_leaderboards` | Crea o actualiza clasificaciones | +| `read_leaderboard_rankings` | Obtiene una clasificación con rankings en vivo por clave (paginación opcional, fecha de ejecución, centrado en usuario y filtros de atributos) | -## Herramientas de Puntos {#points-tools} +### Herramientas de Puntos {#points-tools} -Configura sistemas completos de [Puntos](/es/features/points), incluyendo [Desencadenadores](/es/features/points#points-triggers), [Niveles](/es/features/points#points-levels) y [Impulsos](/es/features/points#points-boosts). +Configura sistemas completos de [Puntos](/es/features/points), incluyendo [Activadores](/es/features/points#points-triggers), [Niveles](/es/features/points#points-levels) y [Potenciadores](/es/features/points#points-boosts), y consulta análisis de distribución. | Herramienta | Qué hace | | --- | --- | -| `read_points_systems` | Lista sistemas de puntos u obtiene uno por ID | -| `write_points_systems` | Crea o actualiza sistemas de puntos (opcionalmente con desencadenadores, niveles e impulsos anidados) | -| `read_points_triggers` | Lista u obtiene desencadenadores para un sistema de puntos | -| `write_points_triggers` | Crea o actualiza desencadenadores para un sistema de puntos | -| `read_points_levels` | Lista u obtiene niveles para un sistema de puntos | +| `read_points_systems` | Lista sistemas de puntos u obtén uno por ID | +| `write_points_systems` | Crea o actualiza sistemas de puntos (opcionalmente con activadores, niveles y potenciadores anidados) | +| `read_points_triggers` | Lista u obtén activadores para un sistema de puntos | +| `write_points_triggers` | Crea o actualiza activadores para un sistema de puntos | +| `read_points_levels` | Lista u obtén niveles para un sistema de puntos | | `write_points_levels` | Crea o actualiza niveles para un sistema de puntos | -| `read_points_boosts` | Lista u obtiene impulsos para un sistema de puntos | -| `write_points_boosts` | Crea o actualiza impulsos para un sistema de puntos | +| `read_points_boosts` | Lista u obtén potenciadores para un sistema de puntos | +| `write_points_boosts` | Crea o actualiza potenciadores para un sistema de puntos | +| `read_points_analytics` | Distribución de puntos y desglose de niveles para un sistema (`summary` o `level_summary`; `user_attributes` opcional en el resumen) | -## Herramientas de Clientes {#tenants-tools} +### Herramientas de Clientes {#tenants-tools} -Administra registros de organizaciones [multicliente](/es/platform/multi-tenancy) cuando la funcionalidad multicliente esté habilitada en tu cuenta. +Administra registros de organizaciones [Multi-Cliente](/es/platform/multi-tenancy) cuando la multi-tenencia esté habilitada en tu cuenta. | Herramienta | Qué hace | | --- | --- | -| `read_tenants` | Lista clientes u obtiene un cliente específico por ID | +| `read_tenants` | Lista clientes u obtén un cliente individual por ID | | `write_tenants` | Crea o actualiza clientes | -Si la funcionalidad multicliente no está habilitada en tu cuenta, estas herramientas no funcionarán. +Si la multi-tenencia no está habilitada en tu cuenta, estas herramientas no funcionarán. -## Herramientas de Rachas {#streaks-tools} +### Herramientas de Rachas {#streaks-tools} -Ejecuta acciones operativas de [rachas](/es/features/streaks) para usuarios, como otorgar [congelaciones de racha](/es/features/streaks#streak-freezes) o [restaurar rachas](/es/features/streaks#restoring-a-users-streak). +Consulta y ejecuta acciones operativas de [Rachas](/es/features/streaks) para usuarios, incluyendo la concesión de [Congelaciones de Racha](/es/features/streaks#streak-freezes) o la [restauración de rachas](/es/features/streaks#restoring-a-users-streak). | Herramienta | Qué hace | | --- | --- | -| `grant_streak_freezes` | Otorga congelaciones de racha a uno o más usuarios | +| `list_user_streaks` | Obtén la longitud de racha (y la marca de tiempo de la última extensión) para hasta 100 usuarios, clasificados de mayor a menor | +| `grant_streak_freezes` | Concede congelaciones de racha a uno o más usuarios | | `restore_streaks` | Restaura una racha interrumpida a su longitud anterior | -## Ejemplos de Prompts {#example-prompts} +## Ejemplos de prompts {#example-prompts} -Usa lenguaje natural — tu agente selecciona la herramienta y los parámetros adecuados: +Usa lenguaje natural: tu agente selecciona la herramienta y los parámetros adecuados: ```text Create an XP system called 'Kudos' that grants 10 points for each workout completed. @@ -88,20 +103,36 @@ Create an XP system called 'Kudos' that grants 10 points for each workout comple Schedule 2X XP boosts for the 'Kudos' system across the next 3 weekends (only for paying users - 'plan' attribute is 'pro'). ``` +```text +List all achievements, completion rates and rarity in my Trophy account. +``` + +```text +Get the top 20 rankings for leaderboard weekly-workouts this week. +``` + +```text +Summarize the Kudos points distribution for pro users. +``` + +```text +What are the current streak lengths for users user_123 and user_456? +``` + ```text Grant two streak freezes to user user_123. ``` ```text -user_123 wants their streak back, restore it to it's previous length. +user_123 wants their streak back, restore it to its previous length. ``` -## Alcance y Seguridad {#scope-and-safety} +## Alcance y seguridad {#scope-and-safety} -- Las herramientas solo actuarán en el [entorno](/es/platform/environments) de Trophy vinculado a la clave API que proporciones en `x-trophy-api-key`. -- Las herramientas de escritura pueden modificar la configuración en vivo. Prefiere un [entorno](/es/platform/environments) de staging o sandbox al iterar. +- Las herramientas solo actuarán sobre el [entorno](/es/platform/environments) de Trophy asociado a la clave de API que proporciones en `x-trophy-api-key`. +- Las herramientas de escritura pueden modificar la configuración activa. Usa un [entorno](/es/platform/environments) de pruebas o sandbox al iterar. - Las herramientas no pueden eliminar recursos. -## Obtén Soporte {#get-support} +## Obtener soporte {#get-support} -¿Quieres ponerte en contacto con el equipo de Trophy? Comunícate con nosotros por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! +¿Quieres ponerte en contacto con el equipo de Trophy? Escríbenos por [correo electrónico](mailto:support@trophy.so). ¡Estamos aquí para ayudarte! diff --git a/i18n.lock b/i18n.lock index 2c6edd7b..1359e7ed 100644 --- a/i18n.lock +++ b/i18n.lock @@ -6897,37 +6897,46 @@ checksums: meta/og%3Adescription: d259b3e6928b7d88c1dbb64c977c4a43 meta/icon: 6d614c8f5f6ed003e80b91204c18d6cc content/0: 2b2564c75024053e56183cb27f8be520 - content/1: a6442a73d2b4fac4341adea7a56d746d + content/1: b4330dafa3dac5108dcb5e6c3292db46 content/2: 6ad2f0783caa2c9b2acf75e16d8628cc - content/3: f5b2e37d277fa26544523c987ea8923f - content/4: 3fb874d8a7837f7831623b29cefecf82 - content/5: 185d03a3079c717c27e2e5634836a799 - content/6: 5744d4bc190dc49b5db047f315582a75 - content/7: 3264a1711449028a91043a9e81fe6e50 - content/8: bd85affdaf880752aeeb4cf3d36dba8d - content/9: d08c6b327fb9446834b3d818b091da0b - content/10: bad5608458ad8bbf16941c7b6d8a14af - content/11: d44673d90f526f8ee29de4a5e8bdfc1d - content/12: 2181c5e4996dfd51484bfa3dea32a94e - content/13: bce5d145cec217d9b7f644627b7b6a1b - content/14: db6d24914c1de085e26560370be977c9 - content/15: 4e267161a4c8ecfb8f604824fc032fa3 - content/16: 0180c590de0eb6e3092150025addc201 - content/17: c3b7e444bfe4ba4de2a4ebb338a99783 - content/18: 906326b6e07826e34997c7e74858b04b - content/19: 431a61acda15a142344c3cac80215f1c - content/20: 16bbbb68d323e2659d94d52164b12213 - content/21: be143a49b206d2248b9e98b5b3f15ad5 - content/22: 30013b95bd839ef992b233407dcfef82 - content/23: df2706de4f3315b291837446b0d7c0d6 - content/24: c98b6438d30b43ed6f280cef4cb1692c - content/25: 933b2903effb251282d947f941b63f3c - content/26: 419d6be21d20157b54608511f2dfe724 - content/27: 8f7ce9f2e1e54867eacd4e6db981a84e - content/28: 1df98519caec0282fe7b984ffd11efb9 - content/29: a99d6101e30525bbeaecd8141f4f73d3 - content/30: 10e8e9a59847ddd720c6d06b12c7b120 - content/31: 9799b973234bf2d10d5c971b267f55a5 + content/3: d3d39a9408122aecc800ed1acb6bdf5d + content/4: 363cfd82b42ca3845932c21f2aec17b1 + content/5: 36fd09aa4fc6676d0e44b00d05f696ab + content/6: 3fb874d8a7837f7831623b29cefecf82 + content/7: 185d03a3079c717c27e2e5634836a799 + content/8: a3b5ae514429379882804eeaac903c6b + content/9: b8d375c4c3435ddefd3775788a4b2a34 + content/10: bd85affdaf880752aeeb4cf3d36dba8d + content/11: 60739acdab57c4dd6ebb9d59134e3f7e + content/12: c69c0d29e5d7afefa7806eab4eed179f + content/13: bd4d420741b6ed836a32509ef1f12f81 + content/14: 6d0c5877625a7c01094632c2ca27aeb0 + content/15: ffd669a767604d70d717ab006c941118 + content/16: ae08379c28ebd8280befbac790370559 + content/17: 2f3e5b2717f8ee4cfc6c84f47fd5b0db + content/18: e018623f1e1e4c682d6da372a629d320 + content/19: 1db39a8f960f08eb96372e8401bbb4ed + content/20: 5cab5d7dafcdd3f16df7ed517e75359e + content/21: 7a496d03c0babb714755fbee4541b728 + content/22: c3b7e444bfe4ba4de2a4ebb338a99783 + content/23: 906326b6e07826e34997c7e74858b04b + content/24: 272a90796e7e3397baab13f3ca781e5c + content/25: 6b8be67f0dd65856e874511da198d90e + content/26: b9be8baa3cdb99d3bb51596d86def07c + content/27: 30013b95bd839ef992b233407dcfef82 + content/28: df2706de4f3315b291837446b0d7c0d6 + content/29: c98b6438d30b43ed6f280cef4cb1692c + content/30: 933b2903effb251282d947f941b63f3c + content/31: 7fd9662dfb12dd16f85f0dff564dbabd + content/32: 2fd9d7f5602d2ef566dfa121145c7496 + content/33: 1afec1e392e0496d4782bc4cca2786c5 + content/34: b8568fa5375e6ed038dc2c99bb7147e2 + content/35: 419d6be21d20157b54608511f2dfe724 + content/36: 6985387a741e8e465ddc4bf3f8b338a3 + content/37: 1df98519caec0282fe7b984ffd11efb9 + content/38: a99d6101e30525bbeaecd8141f4f73d3 + content/39: 10e8e9a59847ddd720c6d06b12c7b120 + content/40: 9799b973234bf2d10d5c971b267f55a5 8526e0bfc63d38ab4ff24fc5b4332813: meta/title: 439cb79e8dfd7923d35b85cfbb6fd201 meta/description: 9a92512ff148e565070ea4b09bc7bd0f diff --git a/mcp/account-mcp-server/capabilities.mdx b/mcp/account-mcp-server/capabilities.mdx index e85d1ef4..0a666282 100644 --- a/mcp/account-mcp-server/capabilities.mdx +++ b/mcp/account-mcp-server/capabilities.mdx @@ -7,12 +7,16 @@ icon: wrench Once connected, the Account MCP Server exposes tools your agent can call to inspect and manage your account. -Most resources offer paired **read** and **write** tools: +Most configuration resources offer paired **read** and **write** tools: - **Read** tools list and fetch resources - **Write** tools create or update resources in batch to speed up operations -## Metrics Tools {#metrics-tools} +## Tool Reference {#tool-reference} + +The full list of tools available in the Trophy Account MCP Server. + +### Metrics Tools {#metrics-tools} Create and manage the [Metrics](/features/metrics) that drive streaks, achievements, points, and leaderboards. @@ -21,27 +25,36 @@ Create and manage the [Metrics](/features/metrics) that drive streaks, achieveme | `read_metrics` | List metrics, or get a single metric by ID | | `write_metrics` | Create or update metrics | -## Attributes Tools {#attributes-tools} +### Attributes Tools {#attributes-tools} -Manage [custom user attributes](/features/users#custom-user-attributes) and [custom event attributes](/features/events#custom-event-attributes) used for feature targeting and personalization. +Manage [Custom User Attributes](/features/users#custom-user-attributes) and [Custom Event Attributes](/features/events#custom-event-attributes) used for feature targeting and personalization. | Tool | What it does | | --- | --- | | `read_attributes` | List attributes, or get a single attribute by ID | | `write_attributes` | Create or update attributes | -## Leaderboards Tools {#leaderboards-tools} +### Achievements Tools {#achievements-tools} + +Read [Achievements](/features/achievements) and completion analytics for your account. + +| Tool | What it does | +| --- | --- | +| `read_achievements` | List achievements with completion counts and rarity; optionally filter by `user_attributes` | + +### Leaderboards Tools {#leaderboards-tools} -Configure [Leaderboards](/features/leaderboards) within your Trophy account. +Configure [Leaderboards](/features/leaderboards) and read live rankings. | Tool | What it does | | --- | --- | | `read_leaderboards` | List leaderboards, or get a single leaderboard by ID | | `write_leaderboards` | Create or update leaderboards | +| `read_leaderboard_rankings` | Get a leaderboard with live rankings by key (optional pagination, run date, user centering, and attribute filters) | -## Points Tools {#points-tools} +### Points Tools {#points-tools} -Configure full [Points](/features/points) systems, including [Triggers](/features/points#points-triggers), [Levels](/features/points#points-levels), and [Boosts](/features/points#points-boosts). +Configure full [Points](/features/points) systems, including [Triggers](/features/points#points-triggers), [Levels](/features/points#points-levels), and [Boosts](/features/points#points-boosts), and read distribution analytics. | Tool | What it does | | --- | --- | @@ -53,10 +66,11 @@ Configure full [Points](/features/points) systems, including [Triggers](/feature | `write_points_levels` | Create or update levels for a points system | | `read_points_boosts` | List or get boosts for a points system | | `write_points_boosts` | Create or update boosts for a points system | +| `read_points_analytics` | Points distribution and level breakdowns for a system (`summary` or `level_summary`; optional `user_attributes` on summary) | -## Tenants Tools {#tenants-tools} +### Tenants Tools {#tenants-tools} -Manage [multi-tenant](/platform/multi-tenancy) organization records when multi-tenancy is enabled on your account. +Manage [Multi-Tenant](/platform/multi-tenancy) organization records when multi-tenancy is enabled on your account. | Tool | What it does | | --- | --- | @@ -67,14 +81,15 @@ Manage [multi-tenant](/platform/multi-tenancy) organization records when multi-t If multi-tenancy is not enabled on your account, these tools will not function. -## Streaks Tools {#streaks-tools} +### Streaks Tools {#streaks-tools} -Run operational [streak](/features/streaks) actions for users, such as granting [streak freezes](/features/streaks#streak-freezes) or [restoring streaks](/features/streaks#restoring-a-users-streak). +Look up and run operational [Streaks](/features/streaks) actions for users, including granting [Streak Freezes](/features/streaks#streak-freezes) or [restoring streaks](/features/streaks#restoring-a-users-streak). | Tool | What it does | | --- | --- | +| `list_user_streaks` | Get streak length (and last extension timestamp) for up to 100 users, ranked longest first | | `grant_streak_freezes` | Grant streak freezes to one or more users | -| `restore_streaks` | Restore a broken streak to it's previous length | +| `restore_streaks` | Restore a broken streak to its previous length | ## Example Prompts {#example-prompts} @@ -88,12 +103,28 @@ Create an XP system called 'Kudos' that grants 10 points for each workout comple Schedule 2X XP boosts for the 'Kudos' system across the next 3 weekends (only for paying users - 'plan' attribute is 'pro'). ``` +```text +List all achievements, completion rates and rarity in my Trophy account. +``` + +```text +Get the top 20 rankings for leaderboard weekly-workouts this week. +``` + +```text +Summarize the Kudos points distribution for pro users. +``` + +```text +What are the current streak lengths for users user_123 and user_456? +``` + ```text Grant two streak freezes to user user_123. ``` ```text -user_123 wants their streak back, restore it to it's previous length. +user_123 wants their streak back, restore it to its previous length. ``` ## Scope and Safety {#scope-and-safety}