datasinking 0.2.9__tar.gz → 0.2.10__tar.gz

{datasinking-0.2.9 → datasinking-0.2.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datasinking
-Version: 0.2.9
+Version: 0.2.10
 Summary: Python client for DataSinking — full-text Asian financial reports (China, Korea, Japan, Taiwan) as Markdown.
 Author: DataSinking
 License: MIT
@@ -73,7 +73,24 @@ output but can't redact a URL.
 
 ### Local — run it yourself
 
-If you'd rather keep everything on your own machine:
+If you'd rather keep everything on your own machine, there are two identical builds — pick
+whichever runtime you already have:
+
+**Node 18+ (no Python needed):**
+
+```json
+{
+  "mcpServers": {
+    "datasinking": {
+      "command": "npx",
+      "args": ["-y", "datasinking-mcp"],
+      "env": { "DATASINK_API_KEY": "YOUR_KEY" }
+    }
+  }
+}
+```
+
+**Python 3.8+:**
 
 ```bash
 pip install "datasinking[mcp]"
@@ -82,6 +99,9 @@ datasinking-mcp          # requires DATASINK_API_KEY (free at https://datasink.i
 
 Then use `command: datasinking-mcp` in your client.
 
+Both run the same six tools with the same schemas — `npm/` and `datasinking/mcp_server.py` are
+kept in lockstep by [`check_mcp_parity.py`](check_mcp_parity.py).
+
 Full per-client setup: [`mcp-server.md`](mcp-server.md).
 
 ![DataSinking MCP in Claude](docs/images/mcp-demo.png)
@@ -95,6 +115,7 @@ datasinking/
 ├── examples/     # Example scripts: pull data from the API and analyze it
 ├── research/     # Research notes / blog posts (reproducing paper-style presentation)
 ├── datasinking/  # Python client + MCP server — pip install "datasinking[mcp]"
+├── npm/          # The same MCP server on npm — npx -y datasinking-mcp (Node 18+)
 ├── mcp-server.md # How to configure the MCP server (for AI agents: Claude / Cursor / Codex / DeepSeek)
 ├── llm-examples.md  # Ask an LLM — no code needed (8 end-to-end examples)
 ├── api-examples.md  # 7 examples × 3 interfaces (curl / Python / LLM)

{datasinking-0.2.9 → datasinking-0.2.10}/README.md

@@ -50,7 +50,24 @@ output but can't redact a URL.
 
 ### Local — run it yourself
 
-If you'd rather keep everything on your own machine:
+If you'd rather keep everything on your own machine, there are two identical builds — pick
+whichever runtime you already have:
+
+**Node 18+ (no Python needed):**
+
+```json
+{
+  "mcpServers": {
+    "datasinking": {
+      "command": "npx",
+      "args": ["-y", "datasinking-mcp"],
+      "env": { "DATASINK_API_KEY": "YOUR_KEY" }
+    }
+  }
+}
+```
+
+**Python 3.8+:**
 
 ```bash
 pip install "datasinking[mcp]"
@@ -59,6 +76,9 @@ datasinking-mcp          # requires DATASINK_API_KEY (free at https://datasink.i
 
 Then use `command: datasinking-mcp` in your client.
 
+Both run the same six tools with the same schemas — `npm/` and `datasinking/mcp_server.py` are
+kept in lockstep by [`check_mcp_parity.py`](check_mcp_parity.py).
+
 Full per-client setup: [`mcp-server.md`](mcp-server.md).
 
 ![DataSinking MCP in Claude](docs/images/mcp-demo.png)
@@ -72,6 +92,7 @@ datasinking/
 ├── examples/     # Example scripts: pull data from the API and analyze it
 ├── research/     # Research notes / blog posts (reproducing paper-style presentation)
 ├── datasinking/  # Python client + MCP server — pip install "datasinking[mcp]"
+├── npm/          # The same MCP server on npm — npx -y datasinking-mcp (Node 18+)
 ├── mcp-server.md # How to configure the MCP server (for AI agents: Claude / Cursor / Codex / DeepSeek)
 ├── llm-examples.md  # Ask an LLM — no code needed (8 end-to-end examples)
 ├── api-examples.md  # 7 examples × 3 interfaces (curl / Python / LLM)

{datasinking-0.2.9 → datasinking-0.2.10}/datasinking/_version.py

@@ -8,4 +8,4 @@ pyproject.toml 用 `dynamic = ["version"]` 从这里读，`client.py` 的 User-A
 写着旧版本）。现在只有这一处需要改。
 """
 
-__version__ = "0.2.9"
+__version__ = "0.2.10"

{datasinking-0.2.9 → datasinking-0.2.10}/datasinking/mcp_server.py

@@ -70,7 +70,7 @@ def _get(path: str, params: Optional[dict] = None) -> dict:
 
 @mcp.tool()
 def list_exchanges() -> list:
-    """List the exchanges DataSinking covers and their report counts.
+    """List the exchanges DataSinking covers.
 
     Returns exchange codes (sse / szse / bj / ksc / koe / knx / jpx / twse / tpex) with
     the number of reports available per exchange. Call this first to discover coverage.
@@ -82,13 +82,13 @@ def list_exchanges() -> list:
 @mcp.tool()
 def list_stocks(
     exchange: Annotated[
-        str, Field(description="Exchange code: sse / szse / bj / ksc / koe / knx / jpx / twse / tpex")
+        str, Field(description="Exchange code, e.g. sse / szse / bj / ksc / koe / knx / jpx / twse / tpex")
     ],
     limit: Annotated[
         int, Field(description="Return only the first N companies (default 20) to keep the response short.")
     ] = 20,
 ) -> dict:
-    """List stocks on an exchange, including the report count per company."""
+    """List the stocks on one exchange, including the report count per company."""
     data = _get("/stocks", {"exchange": exchange})
     return {"exchange": exchange, "total": data.get("total", 0), "items": data.get("items", [])[:limit]}
 
@@ -99,13 +99,13 @@ def list_reports(
         str, Field(description="FMP-style symbol, e.g. 600519.SS / 005930.KS / 7203.T / 2330.TW")
     ],
     doc_type: Annotated[
-        str, Field(description="annual / semiannual / q1 / q3")
+        str, Field(description="Report type to filter on. Defaults to annual.")
     ] = "annual",
     size: Annotated[int, Field(description="Number of reports to return (default 10).")] = 10,
 ) -> dict:
     """List a company's reports — metadata only (id, title, period), no body text.
 
-    Each item carries a ``source`` field naming the official disclosure platform;
+    Each item carries a `source` field naming the official disclosure platform;
     keep that attribution when you cite it.
     """
     return _get("/documents", {"symbol": symbol, "doc_type": doc_type, "size": size})
@@ -115,9 +115,9 @@ def list_reports(
 def get_report(
     document_id: Annotated[int, Field(description="Report id, from list_reports items[].id")],
 ) -> dict:
-    """Fetch a single report's full text (metadata + Markdown body).
+    """Fetch one report's full text (metadata + Markdown body).
 
-    The ``source`` field names the official disclosure platform; keep that attribution
+    The `source` field names the official disclosure platform; keep that attribution
     when you cite it. Expensive in tokens — prefer get_section when you only need one chapter.
     """
     return _get(f"/documents/{document_id}")
@@ -127,13 +127,13 @@ def get_report(
 def list_sections(
     document_id: Annotated[int, Field(description="Report id, from list_reports items[].id")],
 ) -> dict:
-    """List every section of a report with its size — call this before pulling anything.
+    """List every section of a report with its size, before you decide what to pull.
 
-    Returns ``sections`` (titles, in order) plus ``section_details``: the same list as
-    objects with ``title``, ``has_tables``, ``chars`` and ``estimated_tokens``.
+    Returns `sections` (titles, in order) plus `section_details` — same order, one entry
+    per section with `title`, `has_tables`, `chars` and `estimated_tokens`.
 
-    Use ``estimated_tokens`` to avoid pulling a chapter that would blow your context,
-    and ``has_tables`` to know whether a chapter needs special handling (tables are the
+    Use `estimated_tokens` to avoid pulling a chapter that would blow your context,
+    and `has_tables` to know whether the chapter needs special handling (tables are the
     part RAG pipelines usually get wrong). Then call get_section with a heading keyword —
     the headings are in the report's own language.
     """
@@ -157,7 +157,7 @@ def get_section(
         ),
     ],
 ) -> dict:
-    """Fetch only one section of a report by keyword — cheaper than get_report for RAG."""
+    """Fetch only one section of a report by keyword — much cheaper than get_report, best for RAG."""
     return _get(f"/documents/{document_id}", {"section": section})
 
 

{datasinking-0.2.9 → datasinking-0.2.10}/datasinking.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datasinking
-Version: 0.2.9
+Version: 0.2.10
 Summary: Python client for DataSinking — full-text Asian financial reports (China, Korea, Japan, Taiwan) as Markdown.
 Author: DataSinking
 License: MIT
@@ -73,7 +73,24 @@ output but can't redact a URL.
 
 ### Local — run it yourself
 
-If you'd rather keep everything on your own machine:
+If you'd rather keep everything on your own machine, there are two identical builds — pick
+whichever runtime you already have:
+
+**Node 18+ (no Python needed):**
+
+```json
+{
+  "mcpServers": {
+    "datasinking": {
+      "command": "npx",
+      "args": ["-y", "datasinking-mcp"],
+      "env": { "DATASINK_API_KEY": "YOUR_KEY" }
+    }
+  }
+}
+```
+
+**Python 3.8+:**
 
 ```bash
 pip install "datasinking[mcp]"
@@ -82,6 +99,9 @@ datasinking-mcp          # requires DATASINK_API_KEY (free at https://datasink.i
 
 Then use `command: datasinking-mcp` in your client.
 
+Both run the same six tools with the same schemas — `npm/` and `datasinking/mcp_server.py` are
+kept in lockstep by [`check_mcp_parity.py`](check_mcp_parity.py).
+
 Full per-client setup: [`mcp-server.md`](mcp-server.md).
 
 ![DataSinking MCP in Claude](docs/images/mcp-demo.png)
@@ -95,6 +115,7 @@ datasinking/
 ├── examples/     # Example scripts: pull data from the API and analyze it
 ├── research/     # Research notes / blog posts (reproducing paper-style presentation)
 ├── datasinking/  # Python client + MCP server — pip install "datasinking[mcp]"
+├── npm/          # The same MCP server on npm — npx -y datasinking-mcp (Node 18+)
 ├── mcp-server.md # How to configure the MCP server (for AI agents: Claude / Cursor / Codex / DeepSeek)
 ├── llm-examples.md  # Ask an LLM — no code needed (8 end-to-end examples)
 ├── api-examples.md  # 7 examples × 3 interfaces (curl / Python / LLM)