noul-search-agent 2.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. noul_search_agent-2.2.0/LICENSE +201 -0
  2. noul_search_agent-2.2.0/PKG-INFO +290 -0
  3. noul_search_agent-2.2.0/README.md +256 -0
  4. noul_search_agent-2.2.0/agents/AGENTS.snippet.md +4 -0
  5. noul_search_agent-2.2.0/agents/claude-noul-researcher.md +18 -0
  6. noul_search_agent-2.2.0/agents/copilot-noul-researcher.agent.md +11 -0
  7. noul_search_agent-2.2.0/agents/gemini-extension.json +19 -0
  8. noul_search_agent-2.2.0/commands/noul-search-config.md +22 -0
  9. noul_search_agent-2.2.0/pyproject.toml +103 -0
  10. noul_search_agent-2.2.0/setup.cfg +4 -0
  11. noul_search_agent-2.2.0/skills/noul-search/SKILL.md +55 -0
  12. noul_search_agent-2.2.0/skills/noul-search/references/review.md +45 -0
  13. noul_search_agent-2.2.0/skills/noul-search/references/search.md +74 -0
  14. noul_search_agent-2.2.0/skills/noul-search/references/submission.md +33 -0
  15. noul_search_agent-2.2.0/skills/noul-search/references/writing.md +33 -0
  16. noul_search_agent-2.2.0/src/noul/__init__.py +7 -0
  17. noul_search_agent-2.2.0/src/noul/__main__.py +8 -0
  18. noul_search_agent-2.2.0/src/noul/_bin/__init__.py +5 -0
  19. noul_search_agent-2.2.0/src/noul/_bin/noul_cli_launcher.py +10 -0
  20. noul_search_agent-2.2.0/src/noul/_bin/noul_mcp_launcher.py +10 -0
  21. noul_search_agent-2.2.0/src/noul/api/__init__.py +72 -0
  22. noul_search_agent-2.2.0/src/noul/api/analysis.py +93 -0
  23. noul_search_agent-2.2.0/src/noul/api/authoring.py +149 -0
  24. noul_search_agent-2.2.0/src/noul/api/common.py +210 -0
  25. noul_search_agent-2.2.0/src/noul/api/dossiers.py +202 -0
  26. noul_search_agent-2.2.0/src/noul/api/library.py +292 -0
  27. noul_search_agent-2.2.0/src/noul/api/meter.py +99 -0
  28. noul_search_agent-2.2.0/src/noul/api/projects.py +324 -0
  29. noul_search_agent-2.2.0/src/noul/api/review.py +77 -0
  30. noul_search_agent-2.2.0/src/noul/api/search.py +263 -0
  31. noul_search_agent-2.2.0/src/noul/api/settings.py +43 -0
  32. noul_search_agent-2.2.0/src/noul/api/technical.py +154 -0
  33. noul_search_agent-2.2.0/src/noul/cli/__init__.py +122 -0
  34. noul_search_agent-2.2.0/src/noul/cli/commands.py +901 -0
  35. noul_search_agent-2.2.0/src/noul/cli/pretty.py +165 -0
  36. noul_search_agent-2.2.0/src/noul/config.py +219 -0
  37. noul_search_agent-2.2.0/src/noul/errors.py +15 -0
  38. noul_search_agent-2.2.0/src/noul/evidence/__init__.py +1 -0
  39. noul_search_agent-2.2.0/src/noul/evidence/classify.py +107 -0
  40. noul_search_agent-2.2.0/src/noul/evidence/contract.py +160 -0
  41. noul_search_agent-2.2.0/src/noul/evidence/impact.py +72 -0
  42. noul_search_agent-2.2.0/src/noul/evidence/integrity.py +219 -0
  43. noul_search_agent-2.2.0/src/noul/evidence/untrusted.py +122 -0
  44. noul_search_agent-2.2.0/src/noul/ids.py +52 -0
  45. noul_search_agent-2.2.0/src/noul/install.py +531 -0
  46. noul_search_agent-2.2.0/src/noul/library/__init__.py +1 -0
  47. noul_search_agent-2.2.0/src/noul/library/downloads.py +72 -0
  48. noul_search_agent-2.2.0/src/noul/library/export.py +153 -0
  49. noul_search_agent-2.2.0/src/noul/library/fulltext.py +315 -0
  50. noul_search_agent-2.2.0/src/noul/library/graph.py +165 -0
  51. noul_search_agent-2.2.0/src/noul/library/retrieval.py +167 -0
  52. noul_search_agent-2.2.0/src/noul/library/store.py +627 -0
  53. noul_search_agent-2.2.0/src/noul/library/zotero.py +305 -0
  54. noul_search_agent-2.2.0/src/noul/log.py +27 -0
  55. noul_search_agent-2.2.0/src/noul/net/__init__.py +1 -0
  56. noul_search_agent-2.2.0/src/noul/net/cache.py +114 -0
  57. noul_search_agent-2.2.0/src/noul/net/http.py +376 -0
  58. noul_search_agent-2.2.0/src/noul/prompts/__init__.py +1 -0
  59. noul_search_agent-2.2.0/src/noul/prompts/clarification.py +466 -0
  60. noul_search_agent-2.2.0/src/noul/prompts/rubrics_biomedical.py +43 -0
  61. noul_search_agent-2.2.0/src/noul/prompts/rubrics_cs.py +41 -0
  62. noul_search_agent-2.2.0/src/noul/prompts/rubrics_economics.py +42 -0
  63. noul_search_agent-2.2.0/src/noul/prompts/scaffolding.py +19 -0
  64. noul_search_agent-2.2.0/src/noul/providers/__init__.py +1 -0
  65. noul_search_agent-2.2.0/src/noul/providers/annotate.py +37 -0
  66. noul_search_agent-2.2.0/src/noul/providers/artifact_radar.py +261 -0
  67. noul_search_agent-2.2.0/src/noul/providers/arxiv_client.py +769 -0
  68. noul_search_agent-2.2.0/src/noul/providers/arxiv_search.py +81 -0
  69. noul_search_agent-2.2.0/src/noul/providers/assemble.py +56 -0
  70. noul_search_agent-2.2.0/src/noul/providers/crossref.py +62 -0
  71. noul_search_agent-2.2.0/src/noul/providers/domain_classifier.py +725 -0
  72. noul_search_agent-2.2.0/src/noul/providers/endpoints.py +28 -0
  73. noul_search_agent-2.2.0/src/noul/providers/europepmc.py +93 -0
  74. noul_search_agent-2.2.0/src/noul/providers/openalex.py +99 -0
  75. noul_search_agent-2.2.0/src/noul/providers/openalex_client.py +16 -0
  76. noul_search_agent-2.2.0/src/noul/providers/pdf_parser.py +236 -0
  77. noul_search_agent-2.2.0/src/noul/providers/pubmed.py +106 -0
  78. noul_search_agent-2.2.0/src/noul/providers/s2.py +70 -0
  79. noul_search_agent-2.2.0/src/noul/providers/semantic_scholar.py +40 -0
  80. noul_search_agent-2.2.0/src/noul/registry.py +401 -0
  81. noul_search_agent-2.2.0/src/noul/schemas/__init__.py +81 -0
  82. noul_search_agent-2.2.0/src/noul/schemas/analysis.py +65 -0
  83. noul_search_agent-2.2.0/src/noul/schemas/authoring.py +146 -0
  84. noul_search_agent-2.2.0/src/noul/schemas/code.py +19 -0
  85. noul_search_agent-2.2.0/src/noul/schemas/domain.py +10 -0
  86. noul_search_agent-2.2.0/src/noul/schemas/evidence.py +131 -0
  87. noul_search_agent-2.2.0/src/noul/schemas/fulltext.py +50 -0
  88. noul_search_agent-2.2.0/src/noul/schemas/hardware.py +23 -0
  89. noul_search_agent-2.2.0/src/noul/schemas/paper.py +107 -0
  90. noul_search_agent-2.2.0/src/noul/schemas/project.py +147 -0
  91. noul_search_agent-2.2.0/src/noul/schemas/review.py +24 -0
  92. noul_search_agent-2.2.0/src/noul/schemas/technical.py +93 -0
  93. noul_search_agent-2.2.0/src/noul/schemas/tool_inputs.py +563 -0
  94. noul_search_agent-2.2.0/src/noul/schemas/tool_outputs.py +59 -0
  95. noul_search_agent-2.2.0/src/noul/search/__init__.py +1 -0
  96. noul_search_agent-2.2.0/src/noul/search/engine.py +309 -0
  97. noul_search_agent-2.2.0/src/noul/server/__init__.py +1 -0
  98. noul_search_agent-2.2.0/src/noul/server/common.py +390 -0
  99. noul_search_agent-2.2.0/src/noul/server/http.py +313 -0
  100. noul_search_agent-2.2.0/src/noul/server/limits.py +132 -0
  101. noul_search_agent-2.2.0/src/noul/server/mcp.py +485 -0
  102. noul_search_agent-2.2.0/src/noul/tools/__init__.py +1 -0
  103. noul_search_agent-2.2.0/src/noul/tools/authoring/__init__.py +3 -0
  104. noul_search_agent-2.2.0/src/noul/tools/authoring/bibtex.py +527 -0
  105. noul_search_agent-2.2.0/src/noul/tools/authoring/blueprint.py +215 -0
  106. noul_search_agent-2.2.0/src/noul/tools/authoring/citations.py +246 -0
  107. noul_search_agent-2.2.0/src/noul/tools/authoring/common.py +118 -0
  108. noul_search_agent-2.2.0/src/noul/tools/authoring/draft_audit.py +294 -0
  109. noul_search_agent-2.2.0/src/noul/tools/authoring/rebuttal.py +245 -0
  110. noul_search_agent-2.2.0/src/noul/tools/authoring/related_work.py +229 -0
  111. noul_search_agent-2.2.0/src/noul/tools/comparative_tools.py +1242 -0
  112. noul_search_agent-2.2.0/src/noul/tools/gatekeeper_tools.py +516 -0
  113. noul_search_agent-2.2.0/src/noul/tools/hardware_tools.py +299 -0
  114. noul_search_agent-2.2.0/src/noul/tools/review_tools.py +785 -0
  115. noul_search_agent-2.2.0/src/noul/tools/scaffold_tools.py +778 -0
  116. noul_search_agent-2.2.0/src/noul/tools/search_tools.py +604 -0
  117. noul_search_agent-2.2.0/src/noul/tools/technical/__init__.py +3 -0
  118. noul_search_agent-2.2.0/src/noul/tools/technical/ablation.py +234 -0
  119. noul_search_agent-2.2.0/src/noul/tools/technical/common.py +9 -0
  120. noul_search_agent-2.2.0/src/noul/tools/technical/equations.py +600 -0
  121. noul_search_agent-2.2.0/src/noul/tools/technical/failure_modes.py +391 -0
  122. noul_search_agent-2.2.0/src/noul/tools/technical/grounding.py +310 -0
  123. noul_search_agent-2.2.0/src/noul/tools/technical/prompts.py +454 -0
  124. noul_search_agent-2.2.0/src/noul/tools/technical/tables.py +464 -0
  125. noul_search_agent-2.2.0/src/noul/tools/technical/version_diff.py +14 -0
  126. noul_search_agent-2.2.0/src/noul/workspace.py +116 -0
  127. noul_search_agent-2.2.0/src/noul_search_agent.egg-info/PKG-INFO +290 -0
  128. noul_search_agent-2.2.0/src/noul_search_agent.egg-info/SOURCES.txt +178 -0
  129. noul_search_agent-2.2.0/src/noul_search_agent.egg-info/dependency_links.txt +1 -0
  130. noul_search_agent-2.2.0/src/noul_search_agent.egg-info/entry_points.txt +5 -0
  131. noul_search_agent-2.2.0/src/noul_search_agent.egg-info/requires.txt +10 -0
  132. noul_search_agent-2.2.0/src/noul_search_agent.egg-info/top_level.txt +1 -0
  133. noul_search_agent-2.2.0/tests/test_agent.py +667 -0
  134. noul_search_agent-2.2.0/tests/test_artifact_radar.py +211 -0
  135. noul_search_agent-2.2.0/tests/test_arxiv_diff.py +193 -0
  136. noul_search_agent-2.2.0/tests/test_benchmark_tables.py +160 -0
  137. noul_search_agent-2.2.0/tests/test_bibtex_sanitizer.py +123 -0
  138. noul_search_agent-2.2.0/tests/test_boolean_expansion.py +106 -0
  139. noul_search_agent-2.2.0/tests/test_citation_and_related_work.py +179 -0
  140. noul_search_agent-2.2.0/tests/test_citation_graph.py +122 -0
  141. noul_search_agent-2.2.0/tests/test_clarification_loop.py +185 -0
  142. noul_search_agent-2.2.0/tests/test_cli_and_site_sync.py +165 -0
  143. noul_search_agent-2.2.0/tests/test_comparative_matrix.py +118 -0
  144. noul_search_agent-2.2.0/tests/test_dispatch.py +220 -0
  145. noul_search_agent-2.2.0/tests/test_domain_classifier.py +262 -0
  146. noul_search_agent-2.2.0/tests/test_draft_auditor.py +142 -0
  147. noul_search_agent-2.2.0/tests/test_evidence_contract.py +255 -0
  148. noul_search_agent-2.2.0/tests/test_failure_modes.py +119 -0
  149. noul_search_agent-2.2.0/tests/test_foundation.py +75 -0
  150. noul_search_agent-2.2.0/tests/test_fulltext_extraction.py +224 -0
  151. noul_search_agent-2.2.0/tests/test_golden_sets.py +299 -0
  152. noul_search_agent-2.2.0/tests/test_grounding_verifier.py +110 -0
  153. noul_search_agent-2.2.0/tests/test_hardware_estimator.py +158 -0
  154. noul_search_agent-2.2.0/tests/test_http_app.py +183 -0
  155. noul_search_agent-2.2.0/tests/test_http_client.py +219 -0
  156. noul_search_agent-2.2.0/tests/test_installers.py +309 -0
  157. noul_search_agent-2.2.0/tests/test_integrity.py +495 -0
  158. noul_search_agent-2.2.0/tests/test_landing_page.py +100 -0
  159. noul_search_agent-2.2.0/tests/test_layout.py +132 -0
  160. noul_search_agent-2.2.0/tests/test_math_and_ablation.py +194 -0
  161. noul_search_agent-2.2.0/tests/test_mcp_server.py +395 -0
  162. noul_search_agent-2.2.0/tests/test_obsidian_export.py +180 -0
  163. noul_search_agent-2.2.0/tests/test_paper_model.py +158 -0
  164. noul_search_agent-2.2.0/tests/test_paper_references.py +168 -0
  165. noul_search_agent-2.2.0/tests/test_parity.py +81 -0
  166. noul_search_agent-2.2.0/tests/test_project_store.py +640 -0
  167. noul_search_agent-2.2.0/tests/test_prompt_extractor.py +126 -0
  168. noul_search_agent-2.2.0/tests/test_providers_pubmed_openalex.py +279 -0
  169. noul_search_agent-2.2.0/tests/test_public_connector.py +279 -0
  170. noul_search_agent-2.2.0/tests/test_rebuttal_and_gatekeeper.py +187 -0
  171. noul_search_agent-2.2.0/tests/test_registry.py +294 -0
  172. noul_search_agent-2.2.0/tests/test_release_workflow.py +72 -0
  173. noul_search_agent-2.2.0/tests/test_research_gap_engine.py +132 -0
  174. noul_search_agent-2.2.0/tests/test_review_committee.py +183 -0
  175. noul_search_agent-2.2.0/tests/test_scaffolders.py +183 -0
  176. noul_search_agent-2.2.0/tests/test_shared_kernel.py +121 -0
  177. noul_search_agent-2.2.0/tests/test_skill_layout.py +136 -0
  178. noul_search_agent-2.2.0/tests/test_thematic_insights.py +108 -0
  179. noul_search_agent-2.2.0/tests/test_workspace_guard.py +289 -0
  180. noul_search_agent-2.2.0/tests/test_zotero.py +698 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,290 @@
1
+ Metadata-Version: 2.4
2
+ Name: noul-search-agent
3
+ Version: 2.2.0
4
+ Summary: Scientific research co-assistant (MCP server, CLI, skill and subagents): literature search across six open sources, Evidence Meter, research projects, peer-review evidence, academic writing and pre-submission checks. Runs inside the user's own agent (no LLM of its own).
5
+ Author: Ernane Domingues
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://ernanedomingues.github.io/noul-search-agent/
8
+ Project-URL: Documentation, https://ernanedomingues.github.io/noul-search-agent/
9
+ Project-URL: Repository, https://github.com/ernaneDomingues/noul-search-agent
10
+ Project-URL: Issues, https://github.com/ernaneDomingues/noul-search-agent/issues
11
+ Keywords: mcp,model-context-protocol,scientific-literature,co-scientist,peer-review,evidence,openalex,pubmed,semantic-scholar,europe-pmc,arxiv,claude,copilot,codex,gemini
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Environment :: Console
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3 :: Only
19
+ Classifier: Topic :: Scientific/Engineering
20
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
21
+ Requires-Python: >=3.10
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Requires-Dist: httpx>=0.27.0
25
+ Requires-Dist: mcp<3,>=2.3
26
+ Requires-Dist: pydantic>=2.12.0
27
+ Requires-Dist: pypdf>=4.0.0
28
+ Provides-Extra: dev
29
+ Requires-Dist: ruff>=0.6; extra == "dev"
30
+ Requires-Dist: mypy>=1.11; extra == "dev"
31
+ Requires-Dist: pytest>=8.0; extra == "dev"
32
+ Requires-Dist: pytest-cov>=5.0; extra == "dev"
33
+ Dynamic: license-file
34
+
35
+ # Noul Search Agent
36
+
37
+ Noul is a scientific research co-assistant that runs inside the AI assistant you already use (Claude, ChatGPT, Copilot, Cursor, Gemini and other MCP clients). It searches six open scholarly sources, reads full texts, structures the evidence and helps you review papers, write and prepare submissions.
38
+
39
+ **Noul has no LLM of its own.** Its tools retrieve and structure evidence (passages with section and page, signals, checklists); the model in your assistant reasons over that evidence and writes the answer. No API key is required.
40
+
41
+ - **Website and install page:** <https://ernanedomingues.github.io/noul-search-agent/>
42
+ - **Releases:** <https://github.com/ernaneDomingues/noul-search-agent/releases>
43
+
44
+ ## Who it is for
45
+
46
+ | You are | What you get | Start here |
47
+ |---|---|---|
48
+ | **A researcher, clinician or student** who wants answers grounded in the literature | Cited syntheses, an Evidence Meter weighted by study design, retraction checks, persistent research projects, PDF downloads and Zotero/BibTeX export | [Install without a terminal](#install-without-a-terminal) |
49
+ | **An author or reviewer** | Evidence for peer review, checks of numeric claims, citation suggestions, related-work drafts, BibTeX clean-up, rebuttal templates and pre-submission checks | [Install without a terminal](#install-without-a-terminal) |
50
+ | **A developer or AI engineer** | An MCP server with 50 typed tools, a CLI, an HTTP/OpenAPI server and a Claude Code plugin with a skill and subagents | [Install for developers](#install-for-developers) |
51
+
52
+ ## What it does
53
+
54
+ - **Search and weigh the literature.** Multi-source search (OpenAlex, PubMed, Semantic Scholar, Crossref, arXiv, Europe PMC, plus Unpaywall for open-access copies), deduplicated and ranked by study design and citations. The Evidence Meter turns the stances your model assigns into reproducible percentages, raw and weighted by study design.
55
+ - **Read and check papers.** Full-text passages with section and page, citation graphs, retraction and expression-of-concern notices, preprint-to-published links, arXiv version diffs, and extraction of benchmarks, ablations, equations, prompts and hardware requirements.
56
+ - **Review.** Review rubrics per domain (NeurIPS/ICLR, CONSORT/STROBE/PRISMA, causal econometrics), numeric-claim verification against the paper's own text and failure-mode detection. The tools return signals and excerpts, not verdicts or scores.
57
+ - **Write and submit.** Citation recommendations, related-work synthesis, manuscript blueprints and draft audits, BibTeX sanitising, rebuttal templates that never invent results, and pre-submission checks for anonymity and venue requirements.
58
+ - **Keep the work.** Research projects record the question, every paper considered with its status and reason, notes and the search history, across sessions and clients. Export to BibTeX, RIS, CSL-JSON, Markdown dossiers, Obsidian notes or Zotero.
59
+
60
+ Text that comes from papers, PDFs, web pages and reviews is marked as untrusted data, so your assistant does not treat it as instructions.
61
+
62
+ ## Install without a terminal
63
+
64
+ Open the [**install page**](https://ernanedomingues.github.io/noul-search-agent/install.html) and pick your setup:
65
+
66
+ - **Claude Desktop, full version:** download `noul.mcpb` and double-click it. Claude Desktop asks for your e-mail (optional) and the Noul folder.
67
+ - **Single executable** for Windows, macOS and Linux (no Python needed). Open it and a wizard detects your apps and asks where to install Noul.
68
+ - **Claude.ai, Claude Desktop or ChatGPT, nothing to install:** paste the URL of the public read-only connector, once it is live (the install page shows it).
69
+ - **VS Code / Cursor:** one-click install buttons, once the public connector is live.
70
+
71
+ The executables are not digitally signed yet. [`docs/release/signing.md`](docs/release/signing.md) explains how to open them on Windows and macOS and how to verify a download.
72
+
73
+ ## Install for developers
74
+
75
+ Pick **one** of the options. All of them need [`uv`](https://docs.astral.sh/uv/) except the PyPI route with `pipx`.
76
+
77
+ ```bash
78
+ # Claude Code plugin: skill + subagent + /noul-search-config + MCP server
79
+ /plugin marketplace add ernaneDomingues/noul-search-agent
80
+ /plugin install noul-search-agent@noul
81
+
82
+ # From source: installs into every supported agent
83
+ git clone https://github.com/ernaneDomingues/noul-search-agent && cd noul-search-agent
84
+ uv run noul-install --all # every supported environment
85
+ uv run noul-install antigravity claude # or specific ones
86
+ uv run noul-install --all --dry-run # only print what would change
87
+ uv run noul-install --all --uninstall # remove everything cleanly
88
+
89
+ # PyPI (once the package is published)
90
+ pipx install noul-search-agent && noul-install --all
91
+ uvx noul-search-agent install --all --runner uvx # agents start the MCP server through uvx
92
+ ```
93
+
94
+ The installer uses the current interpreter (`sys.executable`, which also works on Windows) or `--runner uvx`. It writes TOML strings that are safe for Windows paths, creates a `.bak` before it first changes an existing configuration file, and leaves corrupted JSON files untouched (exit code 1).
95
+
96
+ To add the server to an MCP client by hand, point it at `noul-mcp` (stdio). From a source checkout:
97
+
98
+ ```json
99
+ {
100
+ "mcpServers": {
101
+ "noul": {
102
+ "command": "uv",
103
+ "args": ["run", "--project", "/path/to/noul-search-agent", "noul-mcp"],
104
+ "env": { "NOUL_WORKSPACE": "/path/to/your/workspace" }
105
+ }
106
+ }
107
+ }
108
+ ```
109
+
110
+ ## Configuration
111
+
112
+ On first use, give a contact e-mail. It enables Unpaywall and the polite pools of OpenAlex, Crossref and NCBI. Noul never invents an e-mail.
113
+
114
+ ```bash
115
+ /noul-search-config email:you@university.edu # installed by noul-install
116
+ /noul-search-agent:noul-search-config email:you@university.edu # Claude Code plugin
117
+ noul config email:you@university.edu --workspace ~/research --download-dir papers
118
+ noul config # show the configuration
119
+ noul config --clear # delete the configuration file
120
+ noul config --zotero-user-id ID --zotero-api-key-stdin # Zotero credentials (terminal or environment only)
121
+ noul config --zotero-remove-key # remove the stored Zotero key
122
+ ```
123
+
124
+ Downloads and dossiers are **always written inside the workspace** (default: the current directory; relative paths are relative to it). Paths outside it, hidden files and folders, and Noul's own folder are refused. The workspace and the Zotero credentials can only be changed from the terminal or through environment variables, never by a tool.
125
+
126
+ | Variable | Purpose |
127
+ |---|---|
128
+ | `NOUL_EMAIL` | Contact e-mail (alternative to `noul config`) |
129
+ | `NOUL_WORKSPACE` | Workspace where downloads and dossiers may be written. Takes priority over the `workspace` saved by `noul config`; with neither, the current folder is used or, if that is the disk root, `~/Documents/Noul` |
130
+ | `NOUL_HOME` | Cache and `config.json` (default `~/.cache/noul-search-agent`) |
131
+ | `NOUL_DB_PATH` | Path of the SQLite cache database |
132
+ | `NOUL_PROJECTS_DB` | Path of the research-projects database (default: `projects.db` next to `config.json`) |
133
+ | `NOUL_TOOL_PROFILE` | Tool profile the server exposes (`research`, `review`, `write`, `all`) |
134
+ | `NOUL_LOG_LEVEL` | Log level of the `noul` logger (stderr) |
135
+ | `NOUL_ALLOW_ANY_PATH=1` | Disables workspace confinement; reserved for isolated tests |
136
+ | `NOUL_INSTALL_RUNNER` | Default runner of the installer (`python`, `uvx`) |
137
+
138
+ ## Usage examples
139
+
140
+ In a chat, just ask: *"What does the literature say about creatine and working memory in healthy adults?"* or *"Review arXiv 2305.14314 as a peer reviewer would."* The same tools are available from the terminal.
141
+
142
+ The examples use `noul` (installed through pip/pipx). From a source checkout, use `uv run noul`.
143
+
144
+ ### 1. Search the literature
145
+ ```bash
146
+ noul search "creatine supplementation cognitive performance" --types meta-analysis,rct --year-min 2018 --pretty
147
+ noul search "retrieval augmented generation hallucination benchmark" --sources openalex,s2,arxiv --pretty
148
+ noul search "statin myopathy" --sources europepmc,pubmed --open-access
149
+ ```
150
+ The `tier` field is a transparent citation/venue band (`top`, `high`, `standard`, `emerging`), **not** a JCR/SJR quartile.
151
+
152
+ ### 2. Find similar papers, references and citing papers
153
+ ```bash
154
+ noul related "doi:10.1093/nutrit/nuac064" --relation all --types meta-analysis,rct
155
+ ```
156
+
157
+ ### 3. Download open-access PDFs (inside the workspace)
158
+ ```bash
159
+ noul download "doi:10.1093/nutrit/nuac064,arxiv:2312.10997" --dir papers
160
+ ```
161
+
162
+ ### 4. Ask questions over the full text of several papers
163
+ ```bash
164
+ noul ask "doi:10.1093/nutrit/nuac064,pmid:29704637" --question "What daily dosage and duration were used?"
165
+ ```
166
+
167
+ ### 5. Evidence Meter
168
+ Your model classifies the stance of each study; the calculation (raw percentages and percentages weighted by study design) is reproducible:
169
+ ```bash
170
+ noul meter '[{"id":"doi:10.1093/nutrit/nuac064","stance":"supportive"},{"id":"pmid:29704637","stance":"inconclusive"}]'
171
+ ```
172
+
173
+ ### 6. HTTP / OpenAPI mode
174
+ ```bash
175
+ noul-mcp --http 8765 # or: uv run noul-mcp --http 8765
176
+ # MCP: http://127.0.0.1:8765/mcp · OpenAPI: /openapi.json · health: /health
177
+ ```
178
+ Security: the server listens on `127.0.0.1` by default and validates the `Host` header (against DNS rebinding). CORS is limited to `NOUL_CORS_ORIGINS`. When `NOUL_HTTP_TOKEN` is set, requests need `Authorization: Bearer` with that token (except `/healthz`); without it, the loopback server is unauthenticated. Tools that write to disk or to an external account (`download_papers`, `save_research_dossier`, `export_obsidian_notes`, `configure_noul`, `zotero_push` and the `project_*` tools that change a project: see the *Writes to disk* column below) are hidden and blocked over HTTP unless `NOUL_HTTP_ALLOW_WRITE=1` **and** a token are set. Other variables: `NOUL_HTTP_HOST`, `PORT`, `NOUL_HTTP_LOG=1`.
179
+
180
+ ### 7. Public connector and Google Cloud Run
181
+ The same server can run as a **public read-only connector**: no login, 12 tools from the `research` profile (no writes and no server-side dossiers), stateless transport, a per-instance limit on tool calls, bounded concurrency and per-call caps announced in the schema. Anyone can use it by pasting `https://<service>/mcp` into Claude.ai/Claude Desktop (Connectors) or ChatGPT (developer mode).
182
+ ```bash
183
+ NOUL_PUBLIC=1 noul-mcp --http 8765 # local (127.0.0.1): expose it through an HTTPS tunnel to test it as a connector
184
+ docker build -t noul-search-agent . && docker run -p 8080:8080 -e NOUL_PUBLIC=1 noul-search-agent
185
+ ```
186
+ Deployment on Cloud Run (scales to zero, no service-account keys, through GitHub Actions): [`docs/deploy/cloud-run.md`](docs/deploy/cloud-run.md).
187
+
188
+ Private server with write access, for yourself: `NOUL_HTTP_TOKEN=change-me NOUL_HTTP_ALLOW_WRITE=1 noul-mcp --http 8765`.
189
+
190
+ ## MCP tools
191
+
192
+ **Research projects.** A project stores the question, every paper considered with its status (`candidate`, `included` or `excluded`) and the reason, the notes and the search history (`search_papers(project=...)` logs each search and adds its results as candidates). It persists across sessions and clients. Tools: `project_create`, `project_list`, `project_get`, `project_add_papers`, `project_set_status`, `project_note`, `project_archive` (hides it from the list, reversible) and `project_delete` (permanent; needs the exact slug and a preview before `confirm: true`). Projects are also available from the CLI (`noul project ...`) and as the MCP resource `noul://project/<slug>`. `save_research_dossier` exports the project of the same name. Write tools are blocked on the HTTP server (unless `NOUL_HTTP_ALLOW_WRITE` is set) and all project tools are hidden on the public connector.
193
+
194
+ **Tool profiles.** To keep the model's context small, the server exposes one profile: `research` (search, reading, Evidence Meter, research projects, dossiers and downloads: 26 tools), `review` (research + review and technical audit), `write` (research + authoring, BibTeX and submission) or `all` (all 50). Default: `all` for local use (stdio: plugin, CLI, `noul-install`) and `research` on the HTTP/remote server. Change it with `noul-mcp --profile review` or `NOUL_TOOL_PROFILE=write` (an invalid value only logs a warning and falls back to the default).
195
+
196
+ The MCP server is built on the official SDK (`mcp` 2.x): stdio and Streamable HTTP (`/mcp`), per-tool annotations (read-only, destructive, network access), `structuredContent` (with `outputSchema` on the tools that have a result model), prompts (`noul-research`, `noul-review`, `noul-write`), per-source progress in `search_papers` and, over stdio, a one-time request for the contact e-mail (on the first full-text or PDF request, if none is configured; a refusal is remembered).
197
+
198
+ The table is generated from the registry (`src/noul/registry.py`) by `scripts/build_site.py`; do not edit it by hand.
199
+
200
+ <!-- noul:tools:start -->
201
+ | Tool | What it does | Profile | Writes to disk |
202
+ |---|---|---|---|
203
+ | `search_papers` | Search peer-reviewed and preprint literature across all scientific disciplines (OpenAlex, PubMed, Semantic Scholar, Crossref, arXiv, Europe PMC), deduplicated and ranked by study design and citations. | research (all) | only with `project` |
204
+ | `clarify_search_scope` | Clarification loop for broad queries: says whether a query is too broad (needs >= 2 of: 5+ meaningful words, boolean operators/quoted phrase, time constraint, method + outcome) and returns 3 domain-specific multiple-choice questions. | research (all) | no |
205
+ | `get_paper` | Get full record and abstract of a paper by cached ID, DOI, PMID, OpenAlex ID, arXiv ID, or Semantic Scholar ID. | research (all) | no |
206
+ | `detect_paper_domain` | Detect a paper's scientific macro-domain (computer_science, biomedical, economics, general_stem) from arXiv categories, fields of study, PubMed indexing, the journal/venue name and title/abstract vocabulary, explaining the signals used. | research (all) | no |
207
+ | `scan_paper_artifacts` | Open-artifact radar: find code repositories (GitHub/GitLab/...), model weights (Hugging Face, Civitai, Kaggle, PyTorch Hub) and datasets (Zenodo, Figshare, OSF, Dataverse, HF datasets) linked from a paper, verify that the links are alive (HEAD, 5s timeout, max 20 URLs) and flag evasive 'available on request' statements. | review | no |
208
+ | `get_paper_references` | Citation graph with influence ranking: papers this paper cites (`backward_citations`) and papers citing it (`forward_citations`), with title, year, venue, citation_count and Semantic Scholar's `is_influential` flag (OpenAlex fallback: >= 50 citations). | research (all) | no |
209
+ | `compare_papers` | Comparative matrix of 1-10 papers (3-5 typical): for each paper extracts the core problem/hypothesis, methodology (design + domain + method sentence), datasets/benchmarks/population, key results/metrics (headline finding, %, p-values, AUC, F1, HR, ...) and declared limitations, then returns a Markdown table plus convergence and divergence summaries. | review | no |
210
+ | `get_thematic_insights` | Thematic synthesis of 1-20 papers across 3 cross-cutting axes (no isolated per-paper summaries): `consolidated_consensuses` (shared concepts, benchmarks and highest-level evidence), `methodological_tensions` (evidence-pyramid gaps, dataset/scale differences, open-artifact asymmetry, mixed results) and `emerging_future_work` (cross-referenced limitations and future work). | review | no |
211
+ | `generate_research_hypotheses` | Autonomous research gap & hypothesis engine: cross-analyzes 2-15 papers to detect methodological contradictions (`contradictions_found`) and unexplored synergies where one paper's method mitigates another's limitation (`unexplored_complementarities`), then formulates 1-`max_hypotheses` structured, testable `ResearchHypothesis` proposals with `source_papers` (>= 2), `proposed_methodology`, `required_baselines`, `target_datasets_or_population`, and `evaluation_metrics`. | review | no |
212
+ | `export_obsidian_notes` | Export papers as atomic Obsidian/Markdown notes (`<Year> - <FirstAuthor> - <ShortTitle>.md`) into `vault_dir` (inside the workspace; default ./obsidian): YAML frontmatter (title, paper_id, doi, year, authors, venue, domain, evidence_level, citations, open_access, has_code, has_weights, tags), TL;DR, key findings & methodology, open artifacts, [[wikilinks]] between the exported notes and a BibTeX block. | write | yes |
213
+ | `suggest_boolean_queries` | Dynamic search expansion: mine acronyms (e.g. | research (all) | no |
214
+ | `extract_benchmark_tables` | Benchmark table extractor: detects Markdown, LaTeX (tabular) and plain-text/PDF tables plus inline `Benchmark: value` pairs in the paper's open-access full text (abstract fallback), keeps the exact model-row x metric-column correspondence, normalizes metric names (gsm-8k -> GSM8K, human-eval -> HumanEval, acc -> Accuracy, ppl -> Perplexity, ...) and converts values like '84.5%' or '84.5 ± 0.3' to numbers. | review | no |
215
+ | `estimate_hardware_specs` | Hardware feasibility / inference footprint: detects the model size (7B, 1.5B, 350M, 8x7B MoE, '671B parameters with 37B activated', family defaults) and architecture (dense, moe, encoder_only, rnn_ssm), then computes FP16/INT8/INT4 weights, KV cache (2 x layers x kv_heads x head_dim x context x bytes) and recommended minimum VRAM (+15% overhead), extracts the authors' reported training hardware (e.g. | review | no |
216
+ | `verify_paper_claims` | Claim grounding with strict attribution: locates each claim (or, when `claims` is empty, the numeric/comparative sentences auto-extracted from the abstract/text) in the paper's literal text, indexed by page and table/section. | review | no |
217
+ | `extract_paper_math` | Math & pseudocode extractor: finds equations (\begin{equation\|align}, $$..$$, \[..\], inline $a = b$, plain-text 'L_total = ...' / 'Attention(Q, K, V) = ...') and algorithms (\begin{algorithm}, 'Algorithm N:' blocks). | review | no |
218
+ | `analyze_ablation_tables` | Ablation analyzer: locates ablation tables/lists (rows 'Full model' / 'Ours' / 'Baseline' and variants 'w/o X', 'without X', '- X', '+ X', 'no X'), takes the full model (else baseline) as reference and computes, per component and metric, delta and delta_percent, flags is_marginal (\|Δ%\| < 1%), ranks components by \|Δ%\| and emits warnings_and_alerts for marginal components and for a single component accounting for >= 60% of the total reported gain. | review | no |
219
+ | `extract_prompts_and_decoding` | Prompt & inference protocol extractor: finds prompt templates (after 'System Prompt:', 'User Prompt:', 'Prompt Template:', 'Instruction:', in code fences/quotes, or text with {variable}, {{variable}}, <context>, "Let's think step by step", "You are an expert") keeping placeholders verbatim and listing `variables`; extracts decoding hyperparameters (temperature, top_p, top_k, max_tokens, repetition_penalty, beam_size, seed, decoding_strategy) with literal evidence, and the JSON output schemas shown in the paper. | review | no |
220
+ | `detect_failure_modes` | Failure mode & critical assumption detector: scans Limitations, Error Analysis, Failure Cases, Discussion, Threats to Validity and Appendix (plus abstract/body) to classify failure modes into long_context, noise_sensitivity, out_of_distribution, latency_or_compute, sample_or_population_bias and general_limitation (as `signals` with the triggering sentence and a priority hint), extracts critical_assumptions, baseline_superiority_scenarios (from text and from benchmark tables where a baseline beats Ours) and operational_limits. | review | no |
221
+ | `diff_arxiv_versions` | arXiv temporal version diff analyzer: fetches and compares two revisions of an arXiv preprint (e.g. | review | no |
222
+ | `review_paper` | Multi-persona peer-review committee: detects the paper's scientific domain (or uses `domain` override) and runs 3 specialized reviewer personas (NeurIPS/ICLR Theoretical, Skeptical Empirical, and Systems/Reproducibility for CS/AI; CONSORT/STROBE Clinical Trial Methodologist, Biostatistician, and Translational Safety Reviewer for Biomedical; Causal Identification Econometrician, Robustness Auditor, and Policy Economist for Economics). | review | no |
223
+ | `review_paper_scientific` | Alias for review_paper: evidence for a domain-adaptive 3-persona scientific peer review; no verdict - you judge with the rubric. | review | no |
224
+ | `scaffold_implementation` | Polyglot code & experimental protocol scaffolder: translates a paper's mathematical formulations, architecture, econometric specification or clinical trial design into executable, ast-validated code + unit tests (PyTorch `nn.Module` with shape assertions for CS/AI; Statsmodels or R `fixest` panel + robustness matrix for Economics; CONSORT/STROBE operational checklist + ITT analytical pipeline for Biomedical/STEM). | review | no |
225
+ | `scaffold_paper_code` | Alias for scaffold_implementation: generates PyTorch, Statsmodels/R, or Clinical Protocol code + unit tests. | review | no |
226
+ | `recommend_citations` | Contextual citation recommender & infiller: scans a draft paragraph or file (.md/.tex) for explicit `[CITATION NEEDED]` / `\cite{?}` markers and unsubstantiated empirical claims, retrieves up to `max_per_claim` candidate supporting papers per claim with a justification quoting each abstract (check that it really backs the claim; candidates known to be retracted - from the search sources or Crossref - are dropped with a warning), inserts inline LaTeX or Markdown citations, and generates a deduplicated BibTeX block. | write | no |
227
+ | `synthesize_related_work` | Narrative Related Work synthesizer: clusters 1-20 papers into thematic approach families (Architectural & Representation Foundations, Training/Optimization/Causal Identification, Efficiency/Scaling/Empirical Evaluation), writes comparative academic prose (While X..., Y..., whereas Z... | write | no |
228
+ | `generate_manuscript_blueprint` | IMRaD manuscript blueprint generator: generates a venue-adapted (neurips, icml, iclr, acl, ieee, nature, lancet, aer, general) structural template with paragraph-by-paragraph writing guidance and required elements in Markdown or LaTeX. | write | no |
229
+ | `audit_manuscript_draft` | Draft manuscript auditor: audits a draft (.md/.tex in workspace or inline text) for weak or unsubstantiated claims, mathematical/terminological inconsistencies ($L$ vs $\mathcal{L}$), and reproducibility omissions (seeds, hyperparameters, sample size N, error bars, compute hardware), as signals quoting the draft with suggested rewrites, a checklist and a rubric; no assessment. | write | no |
230
+ | `sanitize_bibtex` | BibTeX sanitizer & preprint-to-published resolver: parses `.bib` files or text, upgrades arXiv/CoRR preprints (`@misc`) to their definitive peer-reviewed conference (`@inproceedings`) or journal (`@article`) venue with DOI, removes duplicates keeping the cleanest key, standardizes authors, escapes unescaped LaTeX (`&`, `%`, `_`), and protects acronyms (`{LLM}`, `{GPU}`). | write | only with `output_path` |
231
+ | `parse_and_draft_rebuttal` | Peer-review Rebuttal Copilot: segments raw reviewer comments (`Reviewer 1`, `Reviewer 2`, ...) into numbered actionable points, classifies each objection, flags requests requiring new experiments (`requires_new_experiment=True`), and builds a rebuttal skeleton in Markdown and LaTeX whose responses are templates with [TODO] placeholders: help the author fill them with their real results, never invent results. | write | no |
232
+ | `audit_submission_readiness` | Pre-Submission & Desk-Reject Gatekeeper: runs a 4-stage audit on a `.tex`, `.md`, or `.pdf` manuscript for the target `venue` — (1) Double-Blind Anonymity Audit (non-anonymous GitHub/HF URLs, `\author` blocks, PDF metadata, first-person self-citations), (2) Venue Checklist Engine, (3) Overclaiming Scanner, and (4) Mandatory Sections Check - anonymity/overclaiming findings as signals, checklist and sections as a checklist (detected yes/no) and suggested actions; no readiness score: you judge readiness with the returned rubric. | write | no |
233
+ | `get_fulltext` | Fetch open-access full text (via OpenAlex, EuropePMC, arXiv, Unpaywall) and return the passages most relevant to `question` (BM25), each with its section and, when the source has real pages, its page. | research (all) | no |
234
+ | `query_fulltexts` | Query across multiple papers simultaneously for a specific question (uses full text when Open Access or abstract fallback). | research (all) | no |
235
+ | `citation_graph` | Papers this paper cites (references) and papers citing it (OpenAlex), automatically cached for follow-up. | research (all) | no |
236
+ | `related_papers` | Find papers semantically similar to the target paper, papers it cites (references), or papers citing it. | research (all) | no |
237
+ | `download_papers` | Download Open Access PDFs for one or more paper IDs or DOIs into `output_dir` (inside the workspace; default: configured download_dir, ./papers). | research (all) | yes |
238
+ | `export_papers` | Export papers as bibtex, ris, csv or csl-json (imported by Zotero, Mendeley and Pandoc), given `ids` or a research `project` (its included papers, or those of `status`). | research (all) | no |
239
+ | `zotero_push` | Create papers in the user's Zotero library (Web API, needs a key with write access), given `ids` or a research `project`, optionally in an existing `collection`. | research (all) | yes |
240
+ | `save_research_dossier` | Save a persistent research dossier (README.md, papers.json, references.bib) in `output_dir` (inside the workspace; default: configured research_dir, ./research) so the user can converse over the research documentation. | research (all) | yes |
241
+ | `list_research_dossiers` | List saved research dossiers available for follow-up conversation. | research (all) | no |
242
+ | `get_research_dossier` | Load a saved research dossier (Markdown report and paper metadata) by slug or topic. | research (all) | no |
243
+ | `configure_noul` | View (no arguments) or update the persistent Noul configuration: contact email (enables Unpaywall and the OpenAlex/Crossref polite pool) and default download/research folders. | research (all) | yes |
244
+ | `evidence_meter` | Compute the Evidence Meter deterministically from YOUR stance classification of each paper: raw counts and percentages plus study-design-weighted percentages (meta-analysis 1.0 … preclinical 0.2). | research (all) | no |
245
+ | `project_create` | Create a persistent research project for a question. | research (all) | yes |
246
+ | `project_list` | List the user's research projects, most recently updated first, with paper counts per status. | research (all) | no |
247
+ | `project_get` | Get a research project: its question, papers (included first, each with status and reason), notes and search history (`searches`: each query logged with search_papers(project=...), its filters and how many papers it found, returned and added). | research (all) | no |
248
+ | `project_add_papers` | Add papers (ids, DOIs, PMIDs or arXiv ids from search_papers) to a research project with a status (candidate by default) and an optional reason. | research (all) | yes |
249
+ | `project_set_status` | Include or exclude papers of a research project, or move them back to candidate, recording why: the inclusion criterion they meet or fail. | research (all) | yes |
250
+ | `project_note` | Add a note to a research project, optionally attached to one of its papers. | research (all) | yes |
251
+ | `project_archive` | Archive a research project the user has finished or set aside: it leaves project_list (unless `include_archived`) but nothing is deleted, and it stays readable and writable by slug. | research (all) | yes |
252
+ | `project_delete` | Permanently delete a research project: its paper statuses and reasons, notes and search history. | research (all) | yes |
253
+ <!-- noul:tools:end -->
254
+
255
+ ## Repository layout
256
+
257
+ | Path | Role |
258
+ |---|---|
259
+ | `src/noul/search/`, `src/noul/providers/` | Search engine, one module per source, deduplication and ranking; domain classifier, artifact radar, PDF/table parser and arXiv version client |
260
+ | `src/noul/evidence/`, `src/noul/library/`, `src/noul/net/` | Study-design classification and impact bands; full text, citation graph, downloads and export; HTTP with SSRF protection and SQLite cache |
261
+ | `src/noul/registry.py`, `src/noul/api/`, `src/noul/schemas/` | The tool registry (`@tool`), the 50 tool functions and their Pydantic input models, shared by MCP, HTTP/OpenAPI and the CLI (`noul tool <name> --args '<json>'`) |
262
+ | `src/noul/server/` | MCP server (`mcp.py`) and hardened HTTP server (`http.py`) |
263
+ | `src/noul/cli/`, `src/noul/install.py` | `noul` CLI (`python -m noul`) and the user-level installer `noul-install` |
264
+ | `skills/noul-search/`, `agents/`, `commands/`, `.claude-plugin/` | Skill (router, per-journey references, evals), subagent templates, the `/noul-search-config` command and the Claude Code plugin |
265
+ | `site/`, `scripts/build_site.py` | Website published on GitHub Pages; the tool catalog and the install page are generated |
266
+ | `packaging/`, `scripts/build_mcpb.py`, `Dockerfile` | Single-file executable, Claude Desktop extensions (`.mcpb`) and the container image |
267
+
268
+ ## Development
269
+
270
+ ```bash
271
+ uv sync --extra dev
272
+ .venv/bin/ruff check . && .venv/bin/ruff format --check .
273
+ .venv/bin/mypy
274
+ .venv/bin/python -m pytest -p no:cacheprovider --cov # offline tests with a coverage floor
275
+ .venv/bin/python scripts/build_site.py --check # site catalog in sync with the tools
276
+ .venv/bin/python tests/test_golden_sets.py --report # classifier metrics
277
+ ```
278
+
279
+ Guidance for coding agents is in [`CLAUDE.md`](CLAUDE.md). Release notes are on the [releases page](https://github.com/ernaneDomingues/noul-search-agent/releases).
280
+
281
+ ## Limitations and disclaimer
282
+
283
+ - The **Evidence Meter (Noul Meter)** is a heuristic indicator of the distribution of the studies found, not a statistical meta-analysis.
284
+ - Tools return evidence produced by heuristics (classifiers, pattern-based extraction). They can miss things and produce false positives; check signals against the quoted excerpts.
285
+ - Literature summaries on health topics are for information and academic purposes only and are not medical advice.
286
+ - Independent project inspired by the principles of evidence-based medicine and by academic tools such as Consensus and Elicit, with no affiliation with or endorsement by Consensus NLP Inc.
287
+
288
+ ## License
289
+
290
+ Apache-2.0. See [`LICENSE`](LICENSE).