example-mcp-server

Instalação

Configure o servidor MCP em seu cliente preferido. Cada cliente possui um arquivo de configuração próprio, mas todos seguem o mesmo padrão de comando + argumentos + variáveis de ambiente.

{
  "mcpServers": {
    "example-mcp-server": {
      "command": "npx",
      "args": ["-y", "@example/mcp-server"],
      "env": {
        "API_KEY": "your_api_key_here"
      }
    }
  }
}

Transporte

O servidor suporta múltiplos modos de transporte conforme a especificação MCP.

example-mcp --transport http --port 3333

Funções que o modelo pode invocar. Cada tool define um inputSchema JSON Schema e retorna um CallToolResult.

{
  "name": "search_products",
  "arguments": { "query": "notebook", "limit": 5 }
}

{
  "name": "create_order",
  "arguments": {
    "userId": "u_123",
    "items": [{ "productId": "p_1", "qty": 2 }]
  }
}

Recursos acessíveis via URI. Podem ser estáticos ou dinâmicos (com placeholders).

{
  "method": "resources/read",
  "params": { "uri": "products://catalog" }
}

Templates de prompts parametrizáveis que o cliente pode listar e oferecer ao usuário.

{
  "name": "summarize_order",
  "arguments": { "orderId": "o_42", "tone": "casual" }
}

Schemas / Tipos

Tipagens TypeScript dos principais objetos retornados pelas tools e resources.

// Tipos principais do MCP Server

export interface Product {
  id: string;
  name: string;
  price: number;
  stock: number;
}

export interface OrderItem {
  productId: string;
  qty: number;
}

export interface Order {
  id: string;
  userId: string;
  items: OrderItem[];
  total: number;
  status: 'pending' | 'paid' | 'shipped' | 'delivered';
  createdAt: string;
}

export interface User {
  id: string;
  email: string;
  name: string;
}

O servidor utiliza variáveis de ambiente para credenciais. Nunca comite chaves no controle de versão.

export API_KEY="sk-..."
export LOG_LEVEL="info"
example-mcp