Merge pull request #39 from ncdcdev/feat/remove-dead-include-formatting-param

refactor: 未使用のinclude_formattingパラメータを削除

Author: k-ibaraki

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
   pull_request:
-    branches: [ main ]
+    branches: [ main, feat/refine-excel-reading ]
   push:
     branches: [ main ]
 

README.md

@@ -35,9 +35,8 @@ Two authentication methods are supported:
   - Read or search Excel files in SharePoint
   - Search mode: find cells containing specific text with `query` parameter
   - Read mode: get data from specific sheets/ranges with `sheet` and `cell_range` parameters
-  - Response includes data in `rows` and structure info (`freeze_panes`, `merged_ranges`) when available
-  - Default: value + coordinate (structural info such as merged ranges is included when present)
-  - Optional: include_formatting currently does not change the output; structural info is still included only when present
+  - Response includes cell data in `rows` (value and coordinate) and structural information when available
+  - Structural info: sheet name, dimensions, freeze_panes (when present), merged_ranges (when merged cells exist)
   - No Excel Services dependency - uses direct file download + openpyxl parsing
 
 ### OneDrive Support

README_ja.md

@@ -35,9 +35,8 @@ stdioとHTTPの両方のトランスポートに対応しています。
   - SharePoint上のExcelファイルの読み取りと検索
   - 検索モード: `query`パラメータで特定テキストを含むセルを検索
   - 読み取りモード: `sheet`と`cell_range`パラメータで特定シート/範囲を取得
-  - 構造情報（`freeze_panes`）とデータを `rows` で常に返却し、結合セルがある場合は `merged_ranges` も含めて返却
-  - デフォルト: 値と座標のみ（結合セルがある場合は merged / merged_ranges を追加）
-  - オプション: include_formatting を指定しても返却内容（値・座標・結合セル情報など）は変わらない（結合セル情報は結合セルが存在する場合にのみ付与）
+  - レスポンスには`rows`内のセルデータ（値と座標）と構造情報（利用可能な場合）を含む
+  - 構造情報: シート名、dimensions、freeze_panes（存在する場合）、merged_ranges（結合セルが存在する場合）
   - Excel Services不要 - 直接ファイルダウンロード+openpyxl解析方式
 
 ### OneDrive対応

docs/usage.md

@@ -208,7 +208,6 @@ The `sharepoint_excel` tool allows you to read and search Excel files in SharePo
 | `query` | str \| None | None | Search keyword (enables search mode) |
 | `sheet` | str \| None | None | Sheet name (get specific sheet only) |
 | `cell_range` | str \| None | None | Cell range (e.g., "A1:D10") |
-| `include_formatting` | bool | False | Does not change the output currently (merged info is always included when present) |
 
 ### Basic Workflow
 
@@ -276,19 +275,6 @@ result = sharepoint_excel(
 )
 ```
 
-#### 5. include_formatting flag (no output changes yet)
-```python
-# include_formatting flag (currently does not change output)
-result = sharepoint_excel(
-    file_path="/sites/finance/Shared Documents/report.xlsx",
-    sheet="Sheet1",
-    include_formatting=True
-)
-```
-
-Note: `include_formatting=true` currently does not return colors/width/height/types.  
-Merged cell info (`merged` / `merged_ranges`) is always included when present.
-
 ### JSON Output Format
 
 #### Read Mode (Default)
@@ -336,10 +322,9 @@ Merged cell info (`merged` / `merged_ranges`) is always included when present.
 }
 ```
 
-#### Formatting (include_formatting behavior)
+#### Merged Cells
 
-In the current implementation, `include_formatting=true` does not change the output.  
-Merged cell info (`merged` / `merged_ranges`) is included regardless of `include_formatting`.
+When merged cells exist, the response includes merged cell information:
 
 ```json
 {
@@ -380,12 +365,10 @@ Merged cell info (`merged` / `merged_ranges`) is included regardless of `include
 - **value**: Cell value (string, number, date, formula, etc.)
 - **coordinate**: Cell position (e.g., "A1", "B2")
 
-**When merged cells exist (included regardless of include_formatting):**
+**When merged cells exist:**
 - **merged**: Merged cell information (range, position)
 - **merged_ranges**: Merged ranges list per sheet (range + anchor info)
 
-Note: `include_formatting` currently does not add formatting fields.
-
 ### Additional Metadata
 
 Depending on the request, the response can include metadata such as `response_kind`, `data_included`, `requested_sheet`, `requested_range`, `freeze_panes`, `frozen_rows`, `frozen_cols`, `effective_range`, `sheet_resolution`, and `available_sheets`.

docs/usage_ja.md

@@ -208,7 +208,6 @@ results = sharepoint_docs_search(
 | `query` | str \| None | None | 検索キーワード（検索モードを有効化） |
 | `sheet` | str \| None | None | シート名（特定シートのみ取得） |
 | `cell_range` | str \| None | None | セル範囲（例: "A1:D10"） |
-| `include_formatting` | bool | False | 指定しても返却内容は変わらない（結合セル情報は常に含まれる） |
 
 ### 基本的なワークフロー
 
@@ -276,19 +275,6 @@ result = sharepoint_excel(
 )
 ```
 
-#### 5. include_formatting の指定（現状は返却内容は変わらない）
-```python
-# include_formatting を指定（現状は返却内容は変わらない）
-result = sharepoint_excel(
-    file_path="/sites/finance/Shared Documents/report.xlsx",
-    sheet="Sheet1",
-    include_formatting=True
-)
-```
-
-※ 現状 `include_formatting=true` を指定しても、色/幅/高さ/型などの書式情報は返しません。  
-結合セル情報（`merged` / `merged_ranges`）は、シート内に結合セルがある場合に含まれます。
-
 ### JSON出力形式
 
 #### 読み取りモード（デフォルト）
@@ -336,10 +322,9 @@ result = sharepoint_excel(
 }
 ```
 
-#### 書式情報（include_formatting の挙動）
+#### 結合セル
 
-現在の実装では `include_formatting=true` を指定しても返却内容は変わりません。  
-結合セル情報（`merged` / `merged_ranges`）は `include_formatting` の有無に関係なく返ります。
+結合セルが存在する場合、レスポンスには結合セル情報が含まれます:
 
 ```json
 {
@@ -380,12 +365,10 @@ result = sharepoint_excel(
 - **value**: セル値（文字列、数値、日付、数式など）
 - **coordinate**: セル位置（例: "A1"、"B2"）
 
-**結合セルがある場合（include_formattingに関係なく返る）**
+**結合セルがある場合**
 - **merged**: 結合セル情報（範囲、位置）
 - **merged_ranges**: シート内の結合範囲一覧（範囲とアンカー情報）
 
-※ `include_formatting` は指定しても返却内容は変わりません（追加の書式情報は返さない）。
-
 ### 追加で返るメタ情報
 
 レスポンスには必要に応じて `response_kind` / `data_included` / `requested_sheet` / `requested_range` / `freeze_panes` / `frozen_rows` / `frozen_cols` / `effective_range` / `sheet_resolution` / `available_sheets` などのメタ情報が含まれます。
@@ -428,7 +411,7 @@ data = sharepoint_excel(file_path=file_path, sheet="Sheet1", cell_range="A1:D20"
 
 **結合セルの確認**
 ```python
-# Excelデータを取得（include_formattingの有無に関係なく結合情報が含まれる）
+# Excelデータを取得（結合セルがある場合は結合情報が含まれる）
 json_data = sharepoint_excel(file_path=file_path)
 data = json.loads(json_data)
 

src/server.py

@@ -453,7 +453,6 @@ def sharepoint_excel(
     query: str | None = None,
     sheet: str | None = None,
     cell_range: str | None = None,
-    include_formatting: bool = False,
     ctx: Context | None = None,
 ) -> str:
     """
@@ -464,19 +463,14 @@ def sharepoint_excel(
         query: 検索キーワード（指定すると検索モード）
         sheet: シート名（特定シートのみ取得）
         cell_range: セル範囲（例: "A1:D10"）
-        include_formatting: 書式情報を含めるか
-            現状は指定しても返却内容は変わらない
-            ※結合セル情報（merged / merged_ranges）は常に含まれる
-            ※追加の書式情報（data_type / fill / width / height）は返さない
         ctx: FastMCP context (injected automatically)
 
     Returns:
         JSON文字列
     """
     logging.info(
         f"SharePoint Excel operation: {file_path} "
-        f"(query={query}, sheet={sheet}, cell_range={cell_range}, "
-        f"include_formatting={include_formatting})"
+        f"(query={query}, sheet={sheet}, cell_range={cell_range})"
     )
 
     try:
@@ -493,7 +487,6 @@ def sharepoint_excel(
         # 読み取りモード
         return parser.parse_to_json(
             file_path,
-            include_formatting=include_formatting,
             sheet_name=sheet,
             cell_range=cell_range,
         )
@@ -532,14 +525,13 @@ def register_tools():
     if config.is_tool_enabled("sharepoint_excel"):
         mcp.tool(
             description=(
-                "Read or search Excel file in SharePoint. "
-                "Use 'query' parameter to search for specific content and find cell locations. "
-                "Use 'sheet' and 'cell_range' parameters to read specific sections. "
-                "The response includes structure info (sheet name, dimensions, and, when present, freeze_panes and merged_ranges) and data in 'rows'. "
-                "Merged cell info is included when present. "
-                "'include_formatting' currently does not change the output. "
-                "Workflow: 1) Search with query to find relevant cells, "
-                "2) Read specific cell_range based on search results."
+                "Read or search Excel files in SharePoint. "
+                "Search mode: use 'query' parameter to find cells containing specific text (returns cell locations). "
+                "Read mode: use 'sheet' and 'cell_range' parameters to retrieve data from specific sections. "
+                "Response includes cell data in 'rows' (value and coordinate) and structural information "
+                "(sheet name, dimensions, freeze_panes when present, merged_ranges when merged cells exist). "
+                "Recommended workflow: 1) Search with query to locate relevant content, "
+                "2) Read specific range based on search results."
             )
         )(sharepoint_excel)
         logging.info("Registered tool: sharepoint_excel")

src/sharepoint_excel.py

@@ -104,7 +104,6 @@ def search_cells(
     def parse_to_json(
         self,
         file_path: str,
-        include_formatting: bool = False,
         sheet_name: str | None = None,
         cell_range: str | None = None,
     ) -> str:
@@ -113,20 +112,17 @@ def parse_to_json(
 
         Args:
             file_path: Excelファイルのパス
-            include_formatting: 書式情報を含めるかどうか
-                現状は指定しても返却内容は変わらない。
-                - value / coordinate は常に返す
-                - 結合セルがある場合は merged を追加し、merged_ranges を返す
-                ※ data_type / fill / width / height は返さない
             sheet_name: 特定シートのみ取得（Noneで全シート）
             cell_range: セル範囲指定（例: "A1:D10"）
 
         Returns:
-            JSON文字列（全シート・全セルのデータ）
+            JSON文字列
+            - 各セルのデータ: value（値）、coordinate（座標）
+            - 構造情報: シート名、dimensions（範囲）
+            - 条件付き構造情報: freeze_panes（存在する場合）、merged_ranges（結合セルが存在する場合）
         """
         logger.info(
-            f"Parsing Excel file: {file_path} "
-            f"(include_formatting={include_formatting}, sheet={sheet_name}, range={cell_range})"
+            f"Parsing Excel file: {file_path} (sheet={sheet_name}, range={cell_range})"
         )
 
         try:
@@ -202,7 +198,6 @@ def parse_to_json(
                 sheet = workbook[name]
                 sheet_data = self._parse_sheet(
                     sheet,
-                    include_formatting,
                     cell_range,
                 )
                 result["sheets"].append(sheet_data)
@@ -291,15 +286,13 @@ def _scan_sheet(
     def _parse_sheet(
         self,
         sheet,
-        include_formatting: bool,
         cell_range: str | None = None,
     ) -> dict[str, Any]:
         """
         シートを解析してdict形式で返す
 
         Args:
             sheet: openpyxl Worksheet
-            include_formatting: 書式情報を含めるかどうか
             cell_range: セル範囲指定（例: "A1:D10"）
 
         Returns:
@@ -391,7 +384,6 @@ def _parse_sheet(
                 all_rows.extend(
                     self._parse_rows(
                         rows_to_process,
-                        include_formatting,
                         merged_cell_map,
                         merged_anchor_value_map,
                     )
@@ -419,7 +411,6 @@ def _parse_sheet(
                 all_rows.extend(
                     self._parse_rows(
                         rows_to_process,
-                        include_formatting,
                         merged_cell_map,
                         merged_anchor_value_map,
                     )
@@ -601,7 +592,6 @@ def _expand_axis_range(self, range_str: str) -> str:
     def _parse_cell(
         self,
         cell,
-        include_formatting: bool,
         merged_cell_map: dict[str, str] | None = None,
         merged_anchor_value_map: dict[str, Any] | None = None,
     ) -> dict[str, Any]:
@@ -610,7 +600,6 @@ def _parse_cell(
 
         Args:
             cell: openpyxl Cell
-            include_formatting: 書式情報を含めるかどうか
             merged_cell_map: マージセル座標からマージ範囲へのマップ（パフォーマンス最適化用）
             merged_anchor_value_map: マージ範囲 -> アンカー値 のマップ（結合セルの値埋め用）
 
@@ -638,15 +627,12 @@ def _parse_cell(
                 if anchor_value is not None:
                     cell_data["value"] = anchor_value
 
-        # 書式情報（オプション）
-        # 現運用では fill/width/height/data_type は返さない。
-        #       include_formatting を指定しても返却内容は変わらない。
+        # 書式情報（fill/width/height/data_type）は現在サポートされていません
         return cell_data
 
     def _parse_rows(
         self,
         rows: tuple[tuple[Cell, ...], ...],
-        include_formatting: bool,
         merged_cell_map: dict[str, str] | None = None,
         merged_anchor_value_map: dict[str, Any] | None = None,
     ) -> list[list[dict[str, Any]]]:
@@ -655,7 +641,6 @@ def _parse_rows(
 
         Args:
             rows: 行データのタプル
-            include_formatting: 書式情報を含めるか
             merged_cell_map: マージセル情報
             merged_anchor_value_map: マージ範囲 -> アンカー値
 
@@ -667,7 +652,6 @@ def _parse_rows(
             row_data = [
                 self._parse_cell(
                     cell,
-                    include_formatting,
                     merged_cell_map,
                     merged_anchor_value_map,
                 )

tests/test_server.py

@@ -222,7 +222,6 @@ def test_excel_read_default(
                 # デフォルトでは全パラメータがデフォルト値で呼ばれる
                 mock_excel_parser.parse_to_json.assert_called_once_with(
                     "/sites/test/Shared Documents/test.xlsx",
-                    include_formatting=False,
                     sheet_name=None,
                     cell_range=None,
                 )
@@ -262,7 +261,6 @@ def test_excel_with_sheet_parameter(
 
                 mock_excel_parser.parse_to_json.assert_called_once_with(
                     "/sites/test/Shared Documents/test.xlsx",
-                    include_formatting=False,
                     sheet_name="Sheet2",
                     cell_range=None,
                 )
@@ -284,32 +282,10 @@ def test_excel_with_cell_range_parameter(
 
                 mock_excel_parser.parse_to_json.assert_called_once_with(
                     "/sites/test/Shared Documents/test.xlsx",
-                    include_formatting=False,
                     sheet_name="Sheet1",
                     cell_range="A1:D10",
                 )
 
-    @pytest.mark.unit
-    def test_excel_with_formatting(
-        self, mock_config, mock_sharepoint_client, mock_excel_parser
-    ):
-        """書式情報ありのテスト"""
-        with patch(
-            "src.server._get_sharepoint_client", return_value=mock_sharepoint_client
-        ):
-            with patch("src.server.config", mock_config):
-                sharepoint_excel(
-                    file_path="/sites/test/Shared Documents/test.xlsx",
-                    include_formatting=True,
-                )
-
-                mock_excel_parser.parse_to_json.assert_called_once_with(
-                    "/sites/test/Shared Documents/test.xlsx",
-                    include_formatting=True,
-                    sheet_name=None,
-                    cell_range=None,
-                )
-
     @pytest.mark.unit
     def test_excel_with_real_json(
         self, mock_config, mock_sharepoint_client, mock_excel_parser