@mykaarma/mykaarma-mcp-server
v0.0.8
Published
MCP server for MyKaarma API documentation
Downloads
8
Readme
MyKaarma API Documentation MCP Server
An MCP (Model Context Protocol) server that provides access to MyKaarma API documentation with dynamic enum generation and AI-generated summaries.
Features
- Dynamic Enum Generation: Each documentation file becomes a category with an auto-generated enum
- AI-Curated Summaries: Every document includes an AI-generated summary from
file-summaries.json - Simple Interface: Just 2 tools for complete documentation access
- Runtime Discovery: Categories are discovered at runtime from actual files in the docs folder
Available Tools
1. listCategories
Get all available documentation categories. Each file becomes a category with:
- Generated Enum (e.g.,
HOW_TO_CREATE_A_CUSTOMERfromhow-to-create-a-customer.md) - AI Summary (from file-summaries.json)
- Original Filename
2. getDocs
Get specific documentation by category enum. Takes the enum from listCategories and returns:
- Full documentation content
- Metadata (summary, filename, title)
- Last updated timestamp
How It Works
Enum Generation Logic
how-to-create-a-customer.md→HOW_TO_CREATE_A_CUSTOMERauthentication-and-authorization.md→AUTHENTICATION_AND_AUTHORIZATIONmykaarma-webhook-events.md→MYKAARMA_WEBHOOK_EVENTS
Workflow
- Use
listCategoriesto see all available documentation with their enums and summaries - Pick an enum that interests you
- Use
getDocswith that enum to get the full documentation content
File Structure
src/
├── index.ts # MCP server with 2 tools
├── docService.ts # Documentation service with enum generation
└── types.ts # Simple type definitions
docs/ # 52 migrated documentation files
file-summaries.json # AI-generated filename → summary mappingExample Usage
List all categories:
Tool: listCategories Returns: List of all 52 files with their enums and AI summariesGet specific documentation:
Tool: getDocs Input: { category: "HOW_TO_CREATE_A_CUSTOMER" } Returns: Full documentation for creating customers
Documentation Source
All 52 documentation files were intelligently migrated from the official MyKaarma API documentation repository using Gemini AI to:
- Evaluate content value and relevance
- Generate concise summaries
- Filter out non-essential files
Build and Run
# Build the TypeScript project
npm run build
# Start the MCP server
npm start
# Development mode
npm run devVersion
v1.0.0 - Simplified to 2 tools with dynamic enum generation
Configuration
Add to your MCP client configuration:
{
"mcpServers": {
"mykaarma-mcp-server": {
"command": "npx",
"args": ["-y","@mykaarma/mykaarma-mcp-server@latest"]
},
}
}