mcp-framework-starter

by QuantGeekDev

mcp-framework-starter

A Model Context Protocol (MCP) server built with mcp-framework.

Quick Start

# Install dependencies npm install # Build the project npm run build

Project Structure

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

Adding Components

The project comes with an example tool in src/tools/ExampleTool.ts. You can add more tools using the 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

Tool Development

Example tool structure:

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;

Publishing to npm

  1. Update your package.json:
    • Ensure name is unique and follows npm naming conventions
    • Set appropriate version
    • Add description, author, license, etc.
    • Check bin points to the correct entry file
  2. Build and test locally:
    npm run build npm link mcp-framework-starter # Test your CLI locally
  3. Login to npm (create account if necessary):
    npm login
  4. Publish your package:
    npm publish

After publishing, users can add it to their claude desktop client (read below) or run it with 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"] } } }

After Publishing

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

{ "mcpServers": { "mcp-framework-starter": { "command": "npx", "args": ["mcp-framework-starter"] } } }

Building and Testing

  1. Make changes to your tools
  2. Run npm run build to compile
  3. The server will automatically load your tools on startup

Learn More

-
security - not tested
F
license - not found
-
quality - not tested

A starter template for building Model Context Protocol (MCP) servers, enabling developers to create and add custom tools that can be integrated with Claude Desktop.

  1. Quick Start
    1. Project Structure
      1. Adding Components
        1. Tool Development
          1. Publishing to npm
            1. After Publishing
          2. Building and Testing
            1. Learn More

              Related MCP Servers

              • A
                security
                A
                license
                A
                quality
                A beginner-friendly Model Context Protocol (MCP) server that helps users understand MCP concepts, provides interactive examples, and lists available MCP servers. This server is designed to be a helpful companion for developers working with MCP. Also comes with a huge list of servers you can install.
                Last updated -
                3
                9
                36
                JavaScript
                Apache 2.0
              • -
                security
                A
                license
                -
                quality
                MCP Server simplifies the implementation of the Model Context Protocol by providing a user-friendly API to create custom tools and manage server workflows efficiently.
                Last updated -
                4
                3
                TypeScript
                MIT License
              • -
                security
                F
                license
                -
                quality
                A Model Context Protocol server built with mcp-framework that allows users to create and manage custom tools for processing data, integrating with the Claude Desktop via CLI.
                Last updated -
                48
                4
                TypeScript
                • Apple
              • -
                security
                -
                license
                -
                quality
                A specialized server that helps users create new Model Context Protocol (MCP) servers by providing tools and templates for scaffolding projects with various capabilities.
                Last updated -
                1
                TypeScript

              View all related MCP servers

              ID: dptkxh1tjw