Skip to main content

Prompt synchronization MCP server

Project description

Shinkuro - Prompt synchronization MCP server

PyPI - Version Codecov

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

IMPORTANT: make sure your MCP client supports the MCP Prompts capability. See the feature support matrix.

Local Files

Add to your MCP client configuration:

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

Remote Git Repository

Add to your MCP client configuration:

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

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

Private repositories are supported, e.g. "GIT_URL": "git@github.com:DiscreteTom/shinkuro.git" (with SSH keys), "GIT_URL": "https://<username>:<PAT>@github.com/owner/repo.git" (with personal access token)

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 remote repositories (optional, defaults to ~/.shinkuro/remote)
  • AUTO_PULL: Whether to refresh local cache on startup (optional, defaults to false)

Prompt Loading

Each markdown file in the specified folder (including nested folders) is loaded as a prompt.

Example folder structure:

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

The example above will be loaded to 3 prompts: think, code-review and commit.

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.

Example Prompt Repositories

CHANGELOG

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shinkuro-0.3.2.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shinkuro-0.3.2-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file shinkuro-0.3.2.tar.gz.

File metadata

  • Download URL: shinkuro-0.3.2.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for shinkuro-0.3.2.tar.gz
Algorithm Hash digest
SHA256 86e8b554a4c094918137fbac9bc5d1b27f4614078d71c5fab97c7ed43d38382f
MD5 c39df437b8f94493b5919da7ce733536
BLAKE2b-256 ac2ed30debfb2b17619955c19247bab66cc52fdd38300b60c7065046d7b451cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for shinkuro-0.3.2.tar.gz:

Publisher: publish.yml on DiscreteTom/shinkuro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shinkuro-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: shinkuro-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for shinkuro-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 968c5803799a7e517339075f97ae0699551011339da87bb5229b26343ecad155
MD5 9401e267557cf008bc76c21fcb3025b0
BLAKE2b-256 dd0ce33b8bddec287e03ca8b2de38612eed825a9ae6d60a100e7ddb715779293

See more details on using hashes here.

Provenance

The following attestation bundles were made for shinkuro-0.3.2-py3-none-any.whl:

Publisher: publish.yml on DiscreteTom/shinkuro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page