yahoo-furigana-mcp
by analekt
README.md
# Yahoo! ふりがな API MCP サーバ
Yahoo! JAPAN テキスト解析の[ふりがなAPI(V2)](https://developer.yahoo.co.jp/webapi/jlp/furigana/v2/furigana.html)を利用したMCPサーバです。
日本語テキストにふりがな(ひらがな読み)やローマ字を付けることができます。
## 必要な環境
- Node.js 18以上
- Yahoo! JAPAN デベロッパーネットワークの Client ID(アプリケーションID)
- [Yahoo! ID連携 v2 アプリケーションの登録](https://developer.yahoo.co.jp/yconnect/v2/registration.html)から取得できます
## セットアップ
### 1. 依存関係のインストール
```bash
npm install
```
### 2. ビルド
```bash
npm run build
```
## Claude Desktop での設定
### 方法1: npx経由で実行(推奨)
ローカルにリポジトリを配置せず、npm経由で実行する方法です。
`claude_desktop_config.json` に以下を追加してください:
```json
{
"mcpServers": {
"yahoo-furigana": {
"command": "npx",
"args": ["-y", "yahoo-furigana-mcp"],
"env": {
"YAHOO_CLIENT_ID": "あなたのClient ID"
}
}
}
}
```
### 方法2: ローカルから実行
リポジトリをクローンして実行する方法です。
`claude_desktop_config.json` に以下を追加してください:
```json
{
"mcpServers": {
"yahoo-furigana": {
"command": "node",
"args": ["/path/to/yahoo-furigana-mcp/dist/index.js"],
"env": {
"YAHOO_CLIENT_ID": "あなたのClient ID"
}
}
}
}
```
`/path/to/yahoo-furigana-mcp` は実際のパスに置き換えてください。
## 提供するツール
### gen_furigana
日本語テキストにふりがなを付けます。
#### パラメータ
| 名前 | 型 | 必須 | 説明 |
|------|-----|------|------|
| `text` | string | ○ | ふりがなを付けたい日本語テキスト |
| `grade` | number | - | 学年指定(1-8)。指定した学年までに習う漢字にはふりがなを付けません |
| `output_format` | string | - | 出力形式(デフォルト: `ruby`) |
#### output_format の値
| 値 | 説明 | 出力例 |
|----|------|--------|
| `ruby` | HTMLルビ形式(デフォルト) | `<ruby>漢字<rt>かんじ</rt></ruby>` |
| `bracket` | 括弧形式 | `漢字(かんじ)` |
| `roman` | ローマ字付き詳細形式 | `漢字: かんじ (kanji)` |
#### grade の値
| 値 | 対象 |
|----|------|
| 1 | 小学1年生までに習う漢字 |
| 2 | 小学2年生までに習う漢字 |
| 3 | 小学3年生までに習う漢字 |
| 4 | 小学4年生までに習う漢字 |
| 5 | 小学5年生までに習う漢字 |
| 6 | 小学6年生までに習う漢字 |
| 7 | 中学生までに習う漢字 |
| 8 | それ以上 |
#### 使用例
**ruby形式(デフォルト):**
```
入力: "漢字の読み方"
出力: "<ruby>漢字<rt>かんじ</rt></ruby>の<ruby>読<rt>よ</rt></ruby>み<ruby>方<rt>かた</rt></ruby>"
```
**bracket形式:**
```
入力: "漢字の読み方を教えてください"
出力: "漢字(かんじ)の読(よ)み方(かた)を教(おし)えてください"
```
## 特徴
- **自動チャンク分割**: 4KBを超える長いテキストも自動的に分割して処理します。文の区切り(。!?など)で分割するため、自然な結果が得られます。
## npm公開(開発者向け)
このパッケージをnpmに公開する手順:
```bash
# ビルド
npm run build
# パッケージの内容を確認
npm pack --dry-run
# npmにログイン(初回のみ)
npm login
# 公開
npm publish
```
公開後、ユーザーは `npx yahoo-furigana-mcp` でローカルにリポジトリを配置せずに利用できます。
## 制限事項
- Yahoo! JAPAN APIの利用規約に従ってください
## ライセンス
MIT
TDQS
A3.8/5.0
Scored across 1 tool
Disambiguation5/5
With only a single tool, there is no possibility of confusion or overlap. The tool's purpose is clearly distinct by default.
Naming Consistency5/5
The single tool name follows a clear verb_noun pattern (gen_furigana) with no mixed naming conventions. Consistency is trivially maintained.
Tool Count2/5
A single tool is below the reasonable range for a well-scoped server and feels overly thin, even for a narrow purpose. The rubric explicitly treats 1 tool as too few.
Completeness4/5
The server covers the core furigana generation operation for the domain. Minor gaps like configurable output formats or batchprocessing exist but are not critical.
Maintenance
ActivityInactive
ResponsivenessNo issues