Skip to content

docs: McpHttpResponse の body 型が誤記(str ではなく dict|list と記載) #107

@hideyukiMORI

Description

@hideyukiMORI

問題

PR #106 で追加した McpHttpResponse のドキュメントに誤りがある。

ドキュメント(EN / JA 両方)の記載

Fields: `status_code: int`, `body: dict | list`

実際のコード(`src/nene2/mcp/http_client.py`)

```python
@DataClass(frozen=True, slots=True)
class McpHttpResponse:
status_code: int
headers: dict[str, str] # ← ドキュメントに記載なし
body: str # ← str(生テキスト)であって dict|list ではない

def request_id(self) -> str | None:  # ← ドキュメントに記載なし
    return self.headers.get("x-request-id")

```

修正内容

  • docs/reference/framework-modules.md — McpHttpResponse セクションを実装に合わせて修正
  • docs/ja/reference/framework-modules.md — 同上(日本語版)
  • headers: dict[str, str] フィールドを追記
  • request_id() -> str | None メソッドを追記
  • body: str に修正(dict | list を削除)

優先度

高(ドキュメントが実装と正反対の型を示している)

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions