deepresearch-flow 0.7.0__py3-none-any.whl → 0.7.1__py3-none-any.whl

deepresearch_flow/__init__.py

@@ -2,4 +2,4 @@
 
 __all__ = ["__version__"]
 
-__version__ = "0.1.0"
+__version__ = "0.7.1"

{deepresearch_flow-0.7.0.dist-info → deepresearch_flow-0.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepresearch-flow
-Version: 0.7.0
+Version: 0.7.1
 Summary: Workflow tools for paper extraction, review, and research automation.
 Author-email: DengQi <dengqi935@gmail.com>
 License: MIT License
@@ -520,7 +520,14 @@ server {
   }
 
   location /api/ {
-    proxy_pass http://127.0.0.1:8001/;
+    proxy_pass http://127.0.0.1:8001;
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+  }
+
+  location ^~ /mcp {
+    proxy_pass http://127.0.0.1:8001;
     proxy_set_header Host $host;
     proxy_set_header X-Real-IP $remote_addr;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -555,6 +562,147 @@ uv run deepresearch-flow paper db api serve \
   --host 0.0.0.0 --port 8001
 ```
 
+### 3.1) MCP (FastMCP Streamable HTTP)
+
+This project exposes an MCP server mounted at `/mcp` on the snapshot API:
+
+- Endpoint: `http://<host>:8001/mcp` (same host/port as `paper db api serve`)
+- Transport: Streamable HTTP via `POST` only (no SSE; `GET` returns 405)
+- Protocol header: optional `mcp-protocol-version` (`2025-03-26` or `2025-06-18`)
+- Static reads: summary/source/translation are served as **text content** by reading snapshot static assets (local-first via `PAPER_DB_STATIC_EXPORT_DIR`, HTTP fallback via `PAPER_DB_STATIC_BASE` / `PAPER_DB_STATIC_BASE_URL`)
+
+Optional (avoid HTTP fetch by reading exported assets directly on the API host):
+
+```bash
+export PAPER_DB_STATIC_EXPORT_DIR=/data/paper-static
+```
+
+#### MCP Tools (API functions)
+
+<details>
+<summary><strong>search_papers(query, limit=10)</strong> — full-text search (relevance-ranked)</summary>
+
+- Args:
+  - `query` (str): keywords / topic query
+  - `limit` (int): number of results (clamped to API max page size)
+- Returns: list of `{ paper_id, title, year, venue, snippet_markdown }`
+
+</details>
+
+<details>
+<summary><strong>search_papers_by_keyword(keyword, limit=10)</strong> — facet keyword search</summary>
+
+- Args:
+  - `keyword` (str): keyword substring
+  - `limit` (int): number of results (clamped)
+- Returns: list of `{ paper_id, title, year, venue, snippet_markdown }`
+
+</details>
+
+<details>
+<summary><strong>get_paper_metadata(paper_id)</strong> — metadata + available summary templates</summary>
+
+- Args:
+  - `paper_id` (str)
+- Returns: dict with:
+  - `paper_id`, `title`, `year`, `venue`
+  - `doi`, `arxiv_id`, `openreview_id`, `paper_pw_url`
+  - `preferred_summary_template`, `available_summary_templates`
+
+</details>
+
+<details>
+<summary><strong>get_paper_summary(paper_id, template=None, max_chars=None)</strong> — summary JSON as raw text</summary>
+
+- Notes:
+  - Uses `preferred_summary_template` if `template` is omitted
+  - Returns the **full JSON content** (not a URL)
+- Args:
+  - `paper_id` (str)
+  - `template` (str | null)
+  - `max_chars` (int | null): truncation limit
+- Returns: JSON string (may include a `[truncated: ...]` marker)
+
+</details>
+
+<details>
+<summary><strong>get_paper_source(paper_id, max_chars=None)</strong> — source markdown as raw text</summary>
+
+- Args:
+  - `paper_id` (str)
+  - `max_chars` (int | null): truncation limit
+- Returns: markdown string (may include a `[truncated: ...]` marker)
+
+</details>
+
+<details>
+<summary><strong>get_database_stats()</strong> — snapshot-level stats</summary>
+
+- Returns:
+  - `total`
+  - `years`, `months`: list of `{ value, paper_count }`
+  - `authors`, `venues`, `institutions`, `keywords`, `tags`: top lists of `{ value, paper_count }`
+
+</details>
+
+<details>
+<summary><strong>list_top_facets(category, limit=20)</strong> — top values for one facet</summary>
+
+- Args:
+  - `category`: `author | venue | keyword | institution | tag`
+  - `limit` (int)
+- Returns: list of `{ value, paper_count }`
+
+</details>
+
+<details>
+<summary><strong>filter_papers(author=None, venue=None, year=None, keyword=None, tag=None, limit=10)</strong> — structured filtering</summary>
+
+- Args (all optional except `limit`):
+  - `author`, `venue`, `keyword`, `tag`: substring match
+  - `year`: exact match
+  - `limit` (int): number of results (clamped)
+- Returns: list of `{ paper_id, title, year, venue }`
+
+</details>
+
+#### MCP Resources (URI access)
+
+<details>
+<summary><strong>paper://{paper_id}/metadata</strong> — metadata JSON</summary>
+
+Returns the same content as `get_paper_metadata(paper_id)` (as a JSON string).
+
+</details>
+
+<details>
+<summary><strong>paper://{paper_id}/summary</strong> — preferred summary JSON</summary>
+
+Returns the same content as `get_paper_summary(paper_id)` (preferred template; JSON string).
+
+</details>
+
+<details>
+<summary><strong>paper://{paper_id}/summary/{template}</strong> — summary JSON for template</summary>
+
+Returns the same content as `get_paper_summary(paper_id, template=template)` (JSON string).
+
+</details>
+
+<details>
+<summary><strong>paper://{paper_id}/source</strong> — source markdown</summary>
+
+Returns the same content as `get_paper_source(paper_id)` (markdown string).
+
+</details>
+
+<details>
+<summary><strong>paper://{paper_id}/translation/{lang}</strong> — translated markdown</summary>
+
+Returns translated markdown for `lang` (e.g. `zh`, `ja`) when available.
+
+</details>
+
 ### 4) Frontend (static build or dev)
 
 ```bash
@@ -811,7 +959,7 @@ docker run --rm -p 8899:8899 \
 ```
 
 Notes:
-- nginx listens on 8899 and proxies `/api` to the internal API at `127.0.0.1:8000`.
+- nginx listens on 8899 and proxies `/api` and `/mcp` to the internal API at `127.0.0.1:8000`.
 - Mount your snapshot DB to `/db/papers.db` inside the container.
 - Mount snapshot static assets to `/static` when serving assets from this container (default `PAPER_DB_STATIC_BASE` is `/static`).
 - If `PAPER_DB_STATIC_BASE` is a full URL (e.g. `https://static.example.com`), nginx still serves the frontend locally, while API responses use that external static base for asset links.

{deepresearch_flow-0.7.0.dist-info → deepresearch_flow-0.7.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-deepresearch_flow/__init__.py,sha256=rjP9ES4zJCfEN_MCDYAYPL1mNJZGjojdmbRwnZ9FlEk,83
+deepresearch_flow/__init__.py,sha256=kes-OKst6kwiFPY1FmyOV1E5dHTyyHBCM3Iy0EdDp8g,83
 deepresearch_flow/__main__.py,sha256=Ceo0rMTOhHhwFPD-HyDDagenNsmWEzPmsdYLI7kwKVA,115
 deepresearch_flow/cli.py,sha256=t4oowCNWldL0DrVJ4d0UlRkuGU2qHej_G0mAc_quteQ,455
 deepresearch_flow/paper/__init__.py,sha256=sunaOkcgAJBrfmcaJTumcWbPGVUSGWvOv2a2Yidzy0A,43
@@ -466,9 +466,9 @@ deepresearch_flow/translator/placeholder.py,sha256=mEgqA-dPdOsIhno0h_hzfpXpY2asb
 deepresearch_flow/translator/prompts.py,sha256=EvfBvBIpQXARDj4m87GAyFXJGL8EJeahj_rOmp9mv68,5556
 deepresearch_flow/translator/protector.py,sha256=yUMuS2FgVofK_MRXrcauLRiwNvdCCjNAnh6CcNd686o,11777
 deepresearch_flow/translator/segment.py,sha256=rBFMCLTrvm2GrPc_hNFymi-8Ih2DAtUQlZHCRE9nLaM,5146
-deepresearch_flow-0.7.0.dist-info/licenses/LICENSE,sha256=hT8F2Py1pe6flxq3Ufdm2UKFk0B8CBm0aAQfsLXfvjw,1063
-deepresearch_flow-0.7.0.dist-info/METADATA,sha256=aluWW1CXPeSWCLKopChdbgl_GHEQHByua1fBohr6Mzg,26728
-deepresearch_flow-0.7.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-deepresearch_flow-0.7.0.dist-info/entry_points.txt,sha256=1uIKscs0YRMg_mFsg9NjsaTt4CvQqQ_-zGERUKhhL_Y,65
-deepresearch_flow-0.7.0.dist-info/top_level.txt,sha256=qBl4RvPJNJUbL8CFfMNWxY0HpQLx5RlF_ko-z_aKpm0,18
-deepresearch_flow-0.7.0.dist-info/RECORD,,
+deepresearch_flow-0.7.1.dist-info/licenses/LICENSE,sha256=hT8F2Py1pe6flxq3Ufdm2UKFk0B8CBm0aAQfsLXfvjw,1063
+deepresearch_flow-0.7.1.dist-info/METADATA,sha256=rSmAZMSVrjhXLo6Dte3Gaf9AvVyznUaHd-Ahwn47Ne4,31331
+deepresearch_flow-0.7.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+deepresearch_flow-0.7.1.dist-info/entry_points.txt,sha256=1uIKscs0YRMg_mFsg9NjsaTt4CvQqQ_-zGERUKhhL_Y,65
+deepresearch_flow-0.7.1.dist-info/top_level.txt,sha256=qBl4RvPJNJUbL8CFfMNWxY0HpQLx5RlF_ko-z_aKpm0,18
+deepresearch_flow-0.7.1.dist-info/RECORD,,