@shuji-bonji/rfcxml-mcp 0.1.0 → 0.1.1

package/README.ja.md

@@ -0,0 +1,210 @@
+# RFCXML MCP Server
+
+RFC 文書を **構造的に理解** するための MCP サーバー。
+
+## 目的
+
+既存の RFC MCP サーバー（テキストベース）と異なり、RFCXML の意味構造を活用して：
+
+- **規範性要件（MUST/SHOULD/MAY）** の抽出・構造化
+- **RFC 間依存関係グラフ** の構築
+- **定義語のスコープ管理**
+- **実装チェックリストの自動生成**
+
+を可能にする。
+
+## レイヤー構造
+
+```
+┌─────────────────────────┐
+│  Markdown / PDF         │  表示・共有
+├─────────────────────────┤
+│  翻訳                   │  説明・検証・普及
+├─────────────────────────┤
+│  RFCXML MCP             │  AI と人の共通理解基盤
+├─────────────────────────┤
+│  RFCXML                 │  唯一の真実（Single Source of Truth）
+└─────────────────────────┘
+```
+
+## 既存 MCP との違い
+
+| 機能 | 既存 mcp-rfc | RFCXML MCP |
+|------|-------------|------------|
+| RFC テキスト取得 | ✅ | ✅ |
+| セクション抽出 | ✅ (テキストベース) | ✅ (構造ベース) |
+| MUST/SHOULD/MAY 抽出 | ❌ | ✅ |
+| 条件・例外の構造化 | ❌ | ✅ |
+| RFC 間依存グラフ | ❌ | ✅ |
+| 定義スコープ管理 | ❌ | ✅ |
+| 実装チェックリスト | ❌ | ✅ |
+
+## クイックスタート
+
+### Claude Desktop / Claude Code で使用
+
+MCP 設定ファイルに以下を追加：
+
+```json
+{
+  "mcpServers": {
+    "rfcxml": {
+      "command": "npx",
+      "args": ["-y", "@shuji-bonji/rfcxml-mcp"]
+    }
+  }
+}
+```
+
+設定ファイルの場所：
+- **Claude Desktop (macOS)**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+- **Claude Desktop (Windows)**: `%APPDATA%\Claude\claude_desktop_config.json`
+- **Claude Code**: `.claude/settings.json` または `claude settings` コマンド
+
+### インストール（オプション）
+
+グローバルインストールする場合：
+
+```bash
+npm install -g @shuji-bonji/rfcxml-mcp
+
+# MCP 設定
+{
+  "mcpServers": {
+    "rfcxml": {
+      "command": "rfcxml-mcp"
+    }
+  }
+}
+```
+
+## 利用可能なツール
+
+### Phase 1: 基本構造
+
+- `get_rfc_structure` - セクション階層とメタデータ取得
+- `get_requirements` - 規範性要件（MUST/SHOULD/MAY）の構造化抽出
+- `get_definitions` - 用語定義とスコープ
+
+### Phase 2: 関係性
+
+- `get_rfc_dependencies` - 参照 RFC（normative/informative）
+- `get_related_sections` - 関連セクション（同一 RFC 内）
+
+### Phase 3: 検証支援
+
+- `validate_statement` - 主張が RFC に準拠しているか検証
+- `generate_checklist` - 実装チェックリスト生成
+
+## 古い RFC のサポート
+
+RFC 8650 (2019年12月) 以降は公式 RFCXML v3 形式で提供されていますが、それ以前の RFC は XML が利用できない場合があります。
+
+このサーバーは **自動フォールバック機能** を備えており、XML が取得できない場合はテキスト形式から解析を行います。
+
+### ソース情報
+
+すべてのレスポンスには解析ソース情報が含まれます：
+
+```json
+{
+  "rfc": 6455,
+  "sections": [...],
+  "_source": "text",
+  "_sourceNote": "⚠️ テキストからの解析結果です。精度が低い可能性があります。"
+}
+```
+
+| `_source` | 説明 |
+|-----------|------|
+| `xml` | RFCXML から解析（高精度） |
+| `text` | テキストから解析（中精度） |
+
+### 対応状況
+
+| RFC | 形式 | 備考 |
+|-----|------|------|
+| RFC 8650 以降 | XML | RFCXML v3 公式対応 |
+| RFC 8650 未満 | テキスト | 自動フォールバック |
+
+## 使用例
+
+### 規範性要件の抽出
+
+```typescript
+// ツール呼び出し
+{
+  "tool": "get_requirements",
+  "arguments": {
+    "rfc": 6455,
+    "section": "5.5.1"
+  }
+}
+
+// 結果
+{
+  "section": "5.5.1",
+  "title": "Close",
+  "requirements": [
+    {
+      "id": "R-5.5.1-1",
+      "level": "MUST",
+      "text": "endpoint MUST send a Close frame",
+      "subject": "endpoint",
+      "action": "send Close frame",
+      "condition": "when closing connection",
+      "fullContext": "After sending a control frame indicating..."
+    }
+  ]
+}
+```
+
+### 実装チェックリスト生成
+
+```typescript
+// ツール呼び出し
+{
+  "tool": "generate_checklist",
+  "arguments": {
+    "rfc": 6455,
+    "role": "client"
+  }
+}
+
+// 結果（Markdown）
+## RFC 6455 WebSocket Client 実装チェックリスト
+
+### 必須要件 (MUST)
+- [ ] Opening Handshake で Sec-WebSocket-Key を含める (Section 4.1)
+- [ ] Close フレーム受信後、TCP 接続を閉じる (Section 5.5.1)
+- [ ] マスクキーは予測不可能である必要がある (Section 5.3)
+
+### 推奨要件 (SHOULD)
+- [ ] Close フレームには理由を含める (Section 7.1.6)
+```
+
+## 開発
+
+```bash
+# 依存関係インストール
+npm install
+
+# 開発モード
+npm run dev
+
+# ビルド
+npm run build
+
+# テスト
+npm test
+```
+
+## ライセンス
+
+MIT
+
+## 関連プロジェクト
+
+- [mjpitz/mcp-rfc](https://github.com/mjpitz/mcp-rfc) - テキストベースの RFC MCP
+- [ietf-tools/RFCXML](https://github.com/ietf-tools/RFCXML) - RFCXML スキーマ
+- [xml2rfc](https://xml2rfc.ietf.org/) - IETF 公式ツール

package/README.md

@@ -1,51 +1,47 @@
 # RFCXML MCP Server
 
-RFC 文書を **構造的に理解** するための MCP サーバー。
+A Model Context Protocol (MCP) server for **structured understanding** of RFC documents.
 
-## 目的
+## Purpose
 
-既存の RFC MCP サーバー（テキストベース）と異なり、RFCXML の意味構造を活用して：
+Unlike existing text-based RFC MCP servers, this server leverages the semantic structure of RFCXML to enable:
 
-- **規範性要件（MUST/SHOULD/MAY）** の抽出・構造化
-- **RFC 間依存関係グラフ** の構築
-- **定義語のスコープ管理**
-- **実装チェックリストの自動生成**
+- **Normative requirements extraction** (MUST/SHOULD/MAY) with structured output
+- **RFC dependency graph** construction
+- **Definition scope management**
+- **Implementation checklist generation**
 
-を可能にする。
-
-## レイヤー構造
+## Architecture
 
 ```
 ┌─────────────────────────┐
-│  Markdown / PDF         │  表示・共有
+│  Markdown / PDF         │  Display & Sharing
 ├─────────────────────────┤
-│  翻訳                   │  説明・検証・普及
+│  Translation            │  Explanation & Verification
 ├─────────────────────────┤
-│  RFCXML MCP             │  AI と人の共通理解基盤
+│  RFCXML MCP             │  Common Understanding for AI & Humans
 ├─────────────────────────┤
-│  RFCXML                 │  唯一の真実（Single Source of Truth）
+│  RFCXML                 │  Single Source of Truth
 └─────────────────────────┘
 ```
 
-## 既存 MCP との違い
+## Comparison with Existing MCPs
 
-| 機能 | 既存 mcp-rfc | RFCXML MCP |
-|------|-------------|------------|
-| RFC テキスト取得 | ✅ | ✅ |
-| セクション抽出 | ✅ (テキストベース) | ✅ (構造ベース) |
-| MUST/SHOULD/MAY 抽出 | ❌ | ✅ |
-| 条件・例外の構造化 | ❌ | ✅ |
-| RFC 間依存グラフ | ❌ | ✅ |
-| 定義スコープ管理 | ❌ | ✅ |
-| 実装チェックリスト | ❌ | ✅ |
+| Feature | Existing mcp-rfc | RFCXML MCP |
+|---------|------------------|------------|
+| RFC text retrieval | ✅ | ✅ |
+| Section extraction | ✅ (text-based) | ✅ (structure-based) |
+| MUST/SHOULD/MAY extraction | ❌ | ✅ |
+| Condition/exception structuring | ❌ | ✅ |
+| RFC dependency graph | ❌ | ✅ |
+| Definition scope management | ❌ | ✅ |
+| Implementation checklist | ❌ | ✅ |
 
-## インストール
+## Quick Start
 
-```bash
-npm install @shuji-bonji/rfcxml-mcp
-```
+### Using with Claude Desktop / Claude Code
 
-## MCP 設定
+Add the following to your MCP configuration file:
 
 ```json
 {
@@ -58,61 +54,83 @@ npm install @shuji-bonji/rfcxml-mcp
 }
 ```
 
-## 利用可能なツール
+Configuration file locations:
+- **Claude Desktop (macOS)**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+- **Claude Desktop (Windows)**: `%APPDATA%\Claude\claude_desktop_config.json`
+- **Claude Code**: `.claude/settings.json` or use `claude settings` command
+
+### Installation (Optional)
+
+For global installation:
+
+```bash
+npm install -g @shuji-bonji/rfcxml-mcp
+
+# MCP configuration
+{
+  "mcpServers": {
+    "rfcxml": {
+      "command": "rfcxml-mcp"
+    }
+  }
+}
+```
+
+## Available Tools
 
-### Phase 1: 基本構造
+### Phase 1: Basic Structure
 
-- `get_rfc_structure` - セクション階層とメタデータ取得
-- `get_requirements` - 規範性要件（MUST/SHOULD/MAY）の構造化抽出
-- `get_definitions` - 用語定義とスコープ
+- `get_rfc_structure` - Get section hierarchy and metadata
+- `get_requirements` - Extract normative requirements (MUST/SHOULD/MAY) with structure
+- `get_definitions` - Get term definitions and their scope
 
-### Phase 2: 関係性
+### Phase 2: Relationships
 
-- `get_rfc_dependencies` - 参照 RFC（normative/informative）
-- `get_related_sections` - 関連セクション（同一 RFC 内）
+- `get_rfc_dependencies` - Get referenced RFCs (normative/informative)
+- `get_related_sections` - Get related sections within the same RFC
 
-### Phase 3: 検証支援
+### Phase 3: Verification Support
 
-- `validate_statement` - 主張が RFC に準拠しているか検証
-- `generate_checklist` - 実装チェックリスト生成
+- `validate_statement` - Verify if a statement complies with RFC requirements
+- `generate_checklist` - Generate implementation checklist
 
-## 古い RFC のサポート
+## Legacy RFC Support
 
-RFC 8650 (2019年12月) 以降は公式 RFCXML v3 形式で提供されていますが、それ以前の RFC は XML が利用できない場合があります。
+RFCs published after RFC 8650 (December 2019) are available in official RFCXML v3 format. Earlier RFCs may not have XML available.
 
-このサーバーは **自動フォールバック機能** を備えており、XML が取得できない場合はテキスト形式から解析を行います。
+This server includes **automatic fallback** functionality - when XML is unavailable, it parses the text format instead.
 
-### ソース情報
+### Source Information
 
-すべてのレスポンスには解析ソース情報が含まれます：
+All responses include source information:
 
 ```json
 {
   "rfc": 6455,
   "sections": [...],
   "_source": "text",
-  "_sourceNote": "⚠️ テキストからの解析結果です。精度が低い可能性があります。"
+  "_sourceNote": "⚠️ Parsed from text format. Accuracy may be lower."
 }
 ```
 
-| `_source` | 説明 |
-|-----------|------|
-| `xml` | RFCXML から解析（高精度） |
-| `text` | テキストから解析（中精度） |
+| `_source` | Description |
+|-----------|-------------|
+| `xml` | Parsed from RFCXML (high accuracy) |
+| `text` | Parsed from text (medium accuracy) |
 
-### 対応状況
+### Compatibility
 
-| RFC | 形式 | 備考 |
-|-----|------|------|
-| RFC 8650 以降 | XML | RFCXML v3 公式対応 |
-| RFC 8650 未満 | テキスト | 自動フォールバック |
+| RFC | Format | Notes |
+|-----|--------|-------|
+| RFC 8650+ | XML | Official RFCXML v3 support |
+| Before RFC 8650 | Text | Automatic fallback |
 
-## 使用例
+## Usage Examples
 
-### 規範性要件の抽出
+### Extracting Normative Requirements
 
 ```typescript
-// ツール呼び出し
+// Tool call
 {
   "tool": "get_requirements",
   "arguments": {
@@ -121,7 +139,7 @@ RFC 8650 (2019年12月) 以降は公式 RFCXML v3 形式で提供されていま
   }
 }
 
-// 結果
+// Result
 {
   "section": "5.5.1",
   "title": "Close",
@@ -139,10 +157,10 @@ RFC 8650 (2019年12月) 以降は公式 RFCXML v3 形式で提供されていま
 }
 ```
 
-### 実装チェックリスト生成
+### Generating Implementation Checklist
 
 ```typescript
-// ツール呼び出し
+// Tool call
 {
   "tool": "generate_checklist",
   "arguments": {
@@ -151,40 +169,46 @@ RFC 8650 (2019年12月) 以降は公式 RFCXML v3 形式で提供されていま
   }
 }
 
-// 結果（Markdown）
-## RFC 6455 WebSocket Client 実装チェックリスト
+// Result (Markdown)
+## RFC 6455 WebSocket Client Implementation Checklist
 
-### 必須要件 (MUST)
-- [ ] Opening Handshake で Sec-WebSocket-Key を含める (Section 4.1)
-- [ ] Close フレーム受信後、TCP 接続を閉じる (Section 5.5.1)
-- [ ] マスクキーは予測不可能である必要がある (Section 5.3)
+### Required (MUST)
+- [ ] Include Sec-WebSocket-Key in Opening Handshake (Section 4.1)
+- [ ] Close TCP connection after receiving Close frame (Section 5.5.1)
+- [ ] Mask key must be unpredictable (Section 5.3)
 
-### 推奨要件 (SHOULD)
-- [ ] Close フレームには理由を含める (Section 7.1.6)
+### Recommended (SHOULD)
+- [ ] Include reason in Close frame (Section 7.1.6)
 ```
 
-## 開発
+## Development
 
 ```bash
-# 依存関係インストール
+# Install dependencies
 npm install
 
-# 開発モード
+# Development mode
 npm run dev
 
-# ビルド
+# Build
 npm run build
 
-# テスト
+# Test
 npm test
+
+# Lint
+npm run lint
+
+# Format
+npm run format
 ```
 
-## ライセンス
+## License
 
 MIT
 
-## 関連プロジェクト
+## Related Projects
 
-- [mjpitz/mcp-rfc](https://github.com/mjpitz/mcp-rfc) - テキストベースの RFC MCP
-- [ietf-tools/RFCXML](https://github.com/ietf-tools/RFCXML) - RFCXML スキーマ
-- [xml2rfc](https://xml2rfc.ietf.org/) - IETF 公式ツール
+- [mjpitz/mcp-rfc](https://github.com/mjpitz/mcp-rfc) - Text-based RFC MCP
+- [ietf-tools/RFCXML](https://github.com/ietf-tools/RFCXML) - RFCXML schema
+- [xml2rfc](https://xml2rfc.ietf.org/) - IETF official tool

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shuji-bonji/rfcxml-mcp",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "MCP server for structured understanding of RFC documents via RFCXML",
   "keywords": [
     "mcp",