my-mcp-server

Um modelo para construir servidores Model Context Protocol (MCP) usando o mcp-framework para Node.js.

GitHubExperimente este MCPPatrocinado

Documentação

my-mcp-server

Um servidor Model Context Protocol (MCP) construído com mcp-framework.

Início Rápido

# Install dependencies
npm install

# Build the project
npm run build

Estrutura do Projeto

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

Adicionando Componentes

O projeto vem com uma ferramenta de exemplo em src/tools/ExampleTool.ts. Você pode adicionar mais ferramentas usando a 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

Desenvolvimento de Ferramentas

Exemplo de estrutura de ferramenta:

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;

Publicando no npm

  1. Atualize seu package.json:

    • Garanta que name seja único e siga as convenções de nomenclatura do npm
    • Defina o version apropriado
    • Adicione description, author, license, etc.
    • Verifique se bin aponta para o arquivo de entrada correto

  2. Compile e teste localmente:

    npm run build
npm link
my-mcp-server  # Test your CLI locally

  3. Faça login no npm (crie uma conta se necessário):

    npm login

  4. Publique seu pacote:

    npm publish

Após a publicação, os usuários podem adicioná-lo ao seu cliente desktop do Claude (leia abaixo) ou executá-lo com 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": {
    "my-mcp-server": {
      "command": "node",
      "args":["/absolute/path/to/my-mcp-server/dist/index.js"]
    }
  }
}

Após a Publicação

Adicione esta configuração ao seu arquivo de configuração do Claude Desktop:

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

{
  "mcpServers": {
    "my-mcp-server": {
      "command": "npx",
      "args": ["my-mcp-server"]
    }
  }
}

Compilação e Testes

  1. Faça alterações nas suas ferramentas
  2. Execute npm run build para compilar
  3. O servidor carregará automaticamente suas ferramentas na inicialização

Saiba Mais