Marco de inicio mcp
Un servidor de Protocolo de Contexto de Modelo (MCP) creado con mcp-framework.
Inicio rápido
# Install dependencies
npm install
# Build the project
npm run build
Estructura del proyecto
mcp-framework-starter/
├── src/
│ ├── tools/ # MCP Tools
│ │ └── ExampleTool.ts
│ └── index.ts # Server entry point
├── package.json
└── tsconfig.json
Agregar componentes
El proyecto incluye una herramienta de ejemplo en src/tools/ExampleTool.ts . Puedes agregar más herramientas mediante 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
Ejemplo de estructura de 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
- Actualice su paquete.json:
- Asegúrese de que
name sea único y siga las convenciones de nomenclatura de npm - Establecer
version apropiada - Añadir
description , author , license , etc. - Verificar los puntos
bin en el archivo de entrada correcto
- Construir y probar localmente:
npm run build
npm link
mcp-framework-starter # Test your CLI locally
- Inicie sesión en npm (cree una cuenta si es necesario):
- Publica tu paquete:
Después de publicar, los usuarios pueden agregarlo a su cliente de escritorio Claude (leer a continuación) 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": {
"mcp-framework-starter": {
"command": "node",
"args":["/absolute/path/to/mcp-framework-starter/dist/index.js"]
}
}
}
Después de la publicación
Agregue esta configuración a su archivo de configuración de Claude Desktop:
MacOS : ~/Library/Application Support/Claude/claude_desktop_config.json Windows : %APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"mcp-framework-starter": {
"command": "npx",
"args": ["mcp-framework-starter"]
}
}
}
Construcción y pruebas
- Realizar cambios en sus herramientas
- Ejecute
npm run build para compilar - El servidor cargará automáticamente sus herramientas al iniciarse