Kam MCP Server

🚀 kam-mcp-server

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

🚀 Quick Start

# Install dependencies
npm install

# Build the project
npm run build

📚 Documentation

Project Structure

kam-mcp-server/
├── build/                  # Build output directory
├── src/
│   ├── tools/             # MCP tools
│   │   └── CreatePointBasedElementTool.ts    # Tool for creating point-based elements
│   │   └── CreateLineBasedElementTool.ts     # Tool for creating line-based elements
│   │   └── CreateSurfaceBasedElementTool.ts  # Tool for creating surface-based elements
│   │   └── GetCurrentViewElementsTool.ts      # Tool for getting current view elements
│   │   └── GetAvailableFamilyTypesTool.ts     # Tool for getting available family types
│   │   └── DeleteElementTool.ts               # Tool for deleting elements
│   │   └── GetElementByIdTool.ts              # Tool for getting an element by ID
│   ├── resources/         # MCP resources
│   │   └── KamDocResourceResource.ts         # Kam document resource
│   └── index.ts           # Server entry file
├── package.json            # Project dependencies and configuration
└── tsconfig.json           # TypeScript configuration file

Publishing to npm

1. Update your package.json:

   • Ensure the name is unique and complies with npm naming conventions.
   • Set an appropriate version.
   • Add information such as description, author, and license.
   • Check that bin points to the correct entry file.

2. Build and test locally:

   yarn build
   npm link
   kam-mcp-server          # Test the CLI locally
   

3. Log in to npm (create an account if you don't have one):

   npm login
   

4. Publish your package:

   npm publish
   

After publishing, users can use it in the following ways: add it to the Claude Desktop client or run it via npx.

Using on Claude Desktop

Configuration after Publishing

Add the following configuration to your Claude Desktop configuration file:

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

{
  "mcpServers": {
    "kam-mcp-server": {
      "command": "npx",
      "args": ["-y", "kam-mcp-server", "--port=9099"]
    }
  }
}

Building and Testing

1. Modify your tool files.
2. Run yarn build to build.
3. The server will automatically load your tools after starting.