E Gonghun (Korean Military Service Records)

🚀 Independent Contributors Honors MCP Server

This MCP server is designed to manage and query the honor records of independent contributors, and it also provides functions such as generating public reports.

🚀 Quick Start

Prerequisites

Before you start, make sure you have installed the following tools and environments:

• Operating System: macOS or Windows
• Python: It is recommended to use Python 3.8 or a higher version.
• pip: Used for package management.
• Git: Used for cloning the code repository.

📦 Installation

Clone the Repository

Run the following command in the terminal to clone this repository:

git clone https://github.com/your-repository.git
cd independent-contributors-honors-mcp-server

Install Dependencies

Use the following command to install the necessary Python packages:

uv pip install -e .

Environment Variable Configuration

Copy the env-sample file and name it .env:

cp env-sample .env

Then edit the .env file as needed to configure the environment.

💻 Usage Examples

Configuration for Claude Desktop

macOS Configuration

1. Open the terminal and run the following command:

echo '{
  "ai": {
    "client": "claude-sonnet",
    "model": "anthropic/claude-3-sonnet",
    "api_key_path": "~/.config/anthropic/keys.json"
  },
  "log_level": "INFO"
}' > $(xdg-user-docdir)/Claude/settings.json

2. Open the ~/.config/anthropic/keys.json file and add your API key:

{
  "ANTHROPIC_API_KEY": "your-api-key-here"
}

Windows Configuration

1. Open the command prompt and run the following command:

echo {
  ^
  "ai": {
    ^
    "client": "claude-sonnet",
    ^
    "model": "anthropic/claude-3-sonnet",
    ^
    "api_key_path": "%APPDATA%\Claude\keys.json"
  },
  ^
  "log_level": "INFO"
} > "%ProgramData%\Claude\settings.json"

2. Open the C:\Users\<username>\AppData\Roaming\Claude\keys.json file and add your API key:

{
  "ANTHROPIC_API_KEY": "your-api-key-here"
}

Basic Usage

Query Honor Records

Run the following command in the terminal to query the honor records of specific independent contributors:

independent-contributors-honors-mcp-server get-honors --name "李大" --year 2023

Generate Public Reports

Use the following command to generate an annual public report:

independent-contributors-honors-mcp-server generate-report --year 2023

📚 Documentation

API Usage

Query Honor Records

GET /honors?name={name}&year={year}

Generate Public Reports

POST /reports
Content-Type: application/json

{
  "data": {
    "entries": [ ... ]
  }
}

🔧 Technical Details

Working Principle

1. Server Discovery: The client discovers the MCP server through the network.
2. Protocol Negotiation: The client and the server negotiate the protocol version.
3. Command Execution: Based on the negotiation result, the client sends specific commands, which are then processed by the server.

📄 License

MIT License

Copyright (c) 2024

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This repository is written using Anthropic's Claude 3.7 Tone Model.