Scenario Word

Un servidor para el MCP de scenario-word, construido con el mcp-framework.

GitHubPrueba este MCPPatrocinado

Documentación

scenario-word

Un servidor de Model Context Protocol (MCP) construido con mcp-framework.

Inicio Rápido

# Install dependencies
npm install

# Build the project
npm run build

Estructura del Proyecto

scenario-word/
├── src/
│   ├── tools/        # MCP Tools
│   │   └── ExampleTool.ts
│   └── index.ts      # Server entry point
├── package.json
└── tsconfig.json

Añadir Componentes

El proyecto incluye una herramienta de ejemplo en src/tools/ExampleTool.ts. Puedes añadir más herramientas usando la CLI:

# Add a new tool
mcp add tool my-tool

# Example tools you might create:
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler

Desarrollo de Herramientas

Estructura de ejemplo de una herramienta:

import { MCPTool } from "mcp-framework";
import { z } from "zod";

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool<MyToolInput> {
  name = "my_tool";
  description = "Describes what your tool does";

  schema = {
    message: {
      type: z.string(),
      description: "Description of this input parameter",
    },
  };

  async execute(input: MyToolInput) {
    // Your tool logic here
    return `Processed: ${input.message}`;
  }
}

export default MyTool;

Publicación en npm

  1. Actualiza tu package.json:

    • Asegúrate de que name sea único y siga las convenciones de nomenclatura de npm
    • Establece el version apropiado
    • Añade description, author, license, etc.
    • Verifica que bin apunte al archivo de entrada correcto

  2. Compila y prueba localmente:

    npm run build
npm link
scenario-word  # Test your CLI locally

  3. Inicia sesión en npm (crea una cuenta si es necesario):

    npm login

  4. Publica tu paquete:

    npm publish

Después de publicar, los usuarios pueden añadirlo a su cliente de Claude Desktop (lee abajo) o ejecutarlo con npx


## Using with Claude Desktop

### Local Development

Add this configuration to your Claude Desktop config file:

**MacOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows**: `%APPDATA%/Claude/claude_desktop_config.json`

```json
{
  "mcpServers": {
    "scenario-word": {
      "command": "node",
      "args":["/absolute/path/to/scenario-word/dist/index.js"]
    }
  }
}

Después de Publicar

Añade esta configuración a tu archivo de configuración de Claude Desktop:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "scenario-word": {
      "command": "npx",
      "args": ["scenario-word"]
    }
  }
}

Compilación y Pruebas

  1. Haz cambios en tus herramientas
  2. Ejecuta npm run build para compilar
  3. El servidor cargará automáticamente tus herramientas al iniciar

Aprende Más