mcp-server

by Arnms

262 downloads
Not rated
GitHub

Description

# mcp-server A Model Context Protocol (MCP) server built with mcp-framework. ## Quick Start ```bash # Install dependencies npm install # Build the project npm run build ``` ## Project Structure ``` mcp-server/ ├── src/ │ ├── tools/ # MCP Tools │ │ └── ExampleTool.ts │ └──…

About

# mcp-server A Model Context Protocol (MCP) server built with mcp-framework. ## Quick Start ```bash # Install dependencies npm install # Build the project npm run build ``` ## Project Structure ``` mcp-server/ ├── src/ │ ├── tools/ # MCP Tools │ │ └── ExampleTool.ts │ └── index.ts # Server entry point ├── package.json…

Details

Author
Arnms
Downloads
262
Categories
Other

- Built on mcp‑framework for standard MCP compliance
- CLI to scaffold new tools (mcp add tool <name>)
- TypeScript tool structure with Zod input validation
- Auto‑loading of tools on server startup
- Instructions for local development and npm publishing
- Configuration templates for Claude Desktop integration

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name mcp-server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install dependencies with npm install, build the project with npm run build, then use the CLI to add tools (e.g., mcp add tool my-tool). Tools are defined in TypeScript using the MCPTool class and Zod schemas. After publishing to npm, users can run the server via npx or add it to their Claude Desktop configuration.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "mcp-server": {
            "mcp-server": {
                "command": "node",
                "args": [
                    "/absolute/path/to/mcp-server/dist/index.js"
                ]
            }
        }
    }
}

McpServers

{
    "mcp-server": {
        "command": "node",
        "args": [
            "/absolute/path/to/mcp-server/dist/index.js"
        ]
    }
}

mcp-server

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-server/
├── 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-server # 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-server": {
"command": "node",
"args":["/absolute/path/to/mcp-server/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

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

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

- MCP Framework Github
- MCP Framework Docs

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.