shinkuro 0.3.0

Prompt synchronization MCP server

Shinkuro - Prompt synchronization MCP server

Loads markdown files from a local folder or git repository and serves them as MCP prompts.

Useful when you need to share prompts across organizations.

Usage

Local Files

Add to your MCP client configuration:

{
  "mcpServers": {
    "shinkuro": {
      "command": "uvx",
      "args": ["shinkuro"],
      "env": {
        "FOLDER": "/path/to/prompts"
      }
    }
  }
}

Git Repository

Add to your MCP client configuration:

{
  "mcpServers": {
    "shinkuro": {
      "command": "uvx",
      "args": ["shinkuro"],
      "env": {
        "GIT_URL": "https://github.com/owner/repo.git",
        "FOLDER": "" // optional, subfolder within git repo
      }
    }
  }
}

This will clone the repository into a local cache dir. Make sure you have correct permission.

Environment Variables

• FOLDER: Path to local folder containing markdown files, or subfolder within git repo
• GIT_URL: Git repository URL (supports GitHub, GitLab, SSH, HTTPS with credentials)
• CACHE_DIR: Directory to cache cloned repositories (optional, defaults to ~/.shinkuro/remote)
• AUTO_PULL: Whether to pull latest changes if repo exists locally (optional, defaults to false)

Prompt Loading

Each markdown file in the specified folder is loaded as a prompt.

Example folder structure:

my-prompts/
├── code-review.md
├── dev.md
└── commit.md

Example Prompt Files

Simplest

Commit to git using conventional commit.

Prompt with Metadata

---
name: "code-review" # optional, defaults to filename
title: "Code Review Assistant" # optional, defaults to filename
description: "" # optional, defaults to file path
---

# Code Review

Please review this code for best practices and potential issues.

Prompt with Arguments

---
name: "greeting"
description: "Generate a personalized greeting message"
arguments:
  - name: "user"
    description: "Name of the user"
    # no default = required parameter
  - name: "project"
    description: "Project name"
    default: "MyApp"
---

Say: Hello {user}! Welcome to {project}. Hope you enjoy your stay!

Variables like {user} and {project} will be replaced with actual values when the prompt is retrieved. Use {{var}} (double brackets) to escape and display literal brackets.