veriscope-mcp 1.1.0 → 1.1.1

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.
package/LICENSE CHANGED
@@ -1,6 +1,193 @@
1
+ The MCP project is undergoing a licensing transition from the MIT License to the Apache License, Version 2.0 ("Apache-2.0"). All new code and specification contributions to the project are licensed under Apache-2.0. Documentation contributions (excluding specifications) are licensed under CC-BY-4.0.
2
+
3
+ Contributions for which relicensing consent has been obtained are licensed under Apache-2.0. Contributions made by authors who originally licensed their work under the MIT License and who have not yet granted explicit permission to relicense remain licensed under the MIT License.
4
+
5
+ No rights beyond those granted by the applicable original license are conveyed for such contributions.
6
+
7
+ ---
8
+
9
+ Apache License
10
+ Version 2.0, January 2004
11
+ http://www.apache.org/licenses/
12
+
13
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
14
+
15
+ 1. Definitions.
16
+
17
+ "License" shall mean the terms and conditions for use, reproduction,
18
+ and distribution as defined by Sections 1 through 9 of this document.
19
+
20
+ "Licensor" shall mean the copyright owner or entity authorized by
21
+ the copyright owner that is granting the License.
22
+
23
+ "Legal Entity" shall mean the union of the acting entity and all
24
+ other entities that control, are controlled by, or are under common
25
+ control with that entity. For the purposes of this definition,
26
+ "control" means (i) the power, direct or indirect, to cause the
27
+ direction or management of such entity, whether by contract or
28
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
29
+ outstanding shares, or (iii) beneficial ownership of such entity.
30
+
31
+ "You" (or "Your") shall mean an individual or Legal Entity
32
+ exercising permissions granted by this License.
33
+
34
+ "Source" form shall mean the preferred form for making modifications,
35
+ including but not limited to software source code, documentation
36
+ source, and configuration files.
37
+
38
+ "Object" form shall mean any form resulting from mechanical
39
+ transformation or translation of a Source form, including but
40
+ not limited to compiled object code, generated documentation,
41
+ and conversions to other media types.
42
+
43
+ "Work" shall mean the work of authorship, whether in Source or
44
+ Object form, made available under the License, as indicated by a
45
+ copyright notice that is included in or attached to the work
46
+ (an example is provided in the Appendix below).
47
+
48
+ "Derivative Works" shall mean any work, whether in Source or Object
49
+ form, that is based on (or derived from) the Work and for which the
50
+ editorial revisions, annotations, elaborations, or other modifications
51
+ represent, as a whole, an original work of authorship. For the purposes
52
+ of this License, Derivative Works shall not include works that remain
53
+ separable from, or merely link (or bind by name) to the interfaces of,
54
+ the Work and Derivative Works thereof.
55
+
56
+ "Contribution" shall mean any work of authorship, including
57
+ the original version of the Work and any modifications or additions
58
+ to that Work or Derivative Works thereof, that is intentionally
59
+ submitted to the Licensor for inclusion in the Work by the copyright
60
+ owner or by an individual or Legal Entity authorized to submit on behalf
61
+ of the copyright owner. For the purposes of this definition, "submitted"
62
+ means any form of electronic, verbal, or written communication sent
63
+ to the Licensor or its representatives, including but not limited to
64
+ communication on electronic mailing lists, source code control systems,
65
+ and issue tracking systems that are managed by, or on behalf of, the
66
+ Licensor for the purpose of discussing and improving the Work, but
67
+ excluding communication that is conspicuously marked or otherwise
68
+ designated in writing by the copyright owner as "Not a Contribution."
69
+
70
+ "Contributor" shall mean Licensor and any individual or Legal Entity
71
+ on behalf of whom a Contribution has been received by Licensor and
72
+ subsequently incorporated within the Work.
73
+
74
+ 2. Grant of Copyright License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ copyright license to reproduce, prepare Derivative Works of,
78
+ publicly display, publicly perform, sublicense, and distribute the
79
+ Work and such Derivative Works in Source or Object form.
80
+
81
+ 3. Grant of Patent License. Subject to the terms and conditions of
82
+ this License, each Contributor hereby grants to You a perpetual,
83
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
84
+ (except as stated in this section) patent license to make, have made,
85
+ use, offer to sell, sell, import, and otherwise transfer the Work,
86
+ where such license applies only to those patent claims licensable
87
+ by such Contributor that are necessarily infringed by their
88
+ Contribution(s) alone or by combination of their Contribution(s)
89
+ with the Work to which such Contribution(s) was submitted. If You
90
+ institute patent litigation against any entity (including a
91
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
92
+ or a Contribution incorporated within the Work constitutes direct
93
+ or contributory patent infringement, then any patent licenses
94
+ granted to You under this License for that Work shall terminate
95
+ as of the date such litigation is filed.
96
+
97
+ 4. Redistribution. You may reproduce and distribute copies of the
98
+ Work or Derivative Works thereof in any medium, with or without
99
+ modifications, and in Source or Object form, provided that You
100
+ meet the following conditions:
101
+
102
+ (a) You must give any other recipients of the Work or
103
+ Derivative Works a copy of this License; and
104
+
105
+ (b) You must cause any modified files to carry prominent notices
106
+ stating that You changed the files; and
107
+
108
+ (c) You must retain, in the Source form of any Derivative Works
109
+ that You distribute, all copyright, patent, trademark, and
110
+ attribution notices from the Source form of the Work,
111
+ excluding those notices that do not pertain to any part of
112
+ the Derivative Works; and
113
+
114
+ (d) If the Work includes a "NOTICE" text file as part of its
115
+ distribution, then any Derivative Works that You distribute must
116
+ include a readable copy of the attribution notices contained
117
+ within such NOTICE file, excluding those notices that do not
118
+ pertain to any part of the Derivative Works, in at least one
119
+ of the following places: within a NOTICE text file distributed
120
+ as part of the Derivative Works; within the Source form or
121
+ documentation, if provided along with the Derivative Works; or,
122
+ within a display generated by the Derivative Works, if and
123
+ wherever such third-party notices normally appear. The contents
124
+ of the NOTICE file are for informational purposes only and
125
+ do not modify the License. You may add Your own attribution
126
+ notices within Derivative Works that You distribute, alongside
127
+ or as an addendum to the NOTICE text from the Work, provided
128
+ that such additional attribution notices cannot be construed
129
+ as modifying the License.
130
+
131
+ You may add Your own copyright statement to Your modifications and
132
+ may provide additional or different license terms and conditions
133
+ for use, reproduction, or distribution of Your modifications, or
134
+ for any such Derivative Works as a whole, provided Your use,
135
+ reproduction, and distribution of the Work otherwise complies with
136
+ the conditions stated in this License.
137
+
138
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
139
+ any Contribution intentionally submitted for inclusion in the Work
140
+ by You to the Licensor shall be under the terms and conditions of
141
+ this License, without any additional terms or conditions.
142
+ Notwithstanding the above, nothing herein shall supersede or modify
143
+ the terms of any separate license agreement you may have executed
144
+ with Licensor regarding such Contributions.
145
+
146
+ 6. Trademarks. This License does not grant permission to use the trade
147
+ names, trademarks, service marks, or product names of the Licensor,
148
+ except as required for reasonable and customary use in describing the
149
+ origin of the Work and reproducing the content of the NOTICE file.
150
+
151
+ 7. Disclaimer of Warranty. Unless required by applicable law or
152
+ agreed to in writing, Licensor provides the Work (and each
153
+ Contributor provides its Contributions) on an "AS IS" BASIS,
154
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
155
+ implied, including, without limitation, any warranties or conditions
156
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
157
+ PARTICULAR PURPOSE. You are solely responsible for determining the
158
+ appropriateness of using or redistributing the Work and assume any
159
+ risks associated with Your exercise of permissions under this License.
160
+
161
+ 8. Limitation of Liability. In no event and under no legal theory,
162
+ whether in tort (including negligence), contract, or otherwise,
163
+ unless required by applicable law (such as deliberate and grossly
164
+ negligent acts) or agreed to in writing, shall any Contributor be
165
+ liable to You for damages, including any direct, indirect, special,
166
+ incidental, or consequential damages of any character arising as a
167
+ result of this License or out of the use or inability to use the
168
+ Work (including but not limited to damages for loss of goodwill,
169
+ work stoppage, computer failure or malfunction, or any and all
170
+ other commercial damages or losses), even if such Contributor
171
+ has been advised of the possibility of such damages.
172
+
173
+ 9. Accepting Warranty or Additional Liability. While redistributing
174
+ the Work or Derivative Works thereof, You may choose to offer,
175
+ and charge a fee for, acceptance of support, warranty, indemnity,
176
+ or other liability obligations and/or rights consistent with this
177
+ License. However, in accepting such obligations, You may act only
178
+ on Your own behalf and on Your sole responsibility, not on behalf
179
+ of any other Contributor, and only if You agree to indemnify,
180
+ defend, and hold each Contributor harmless for any liability
181
+ incurred by, or claims asserted against, such Contributor by reason
182
+ of your accepting any such warranty or additional liability.
183
+
184
+ END OF TERMS AND CONDITIONS
185
+
186
+ ---
187
+
1
188
  MIT License
2
189
 
3
- Copyright (c) 2026 VeriScope Sovereign Harbor
190
+ Copyright (c) 2024-2025 Model Context Protocol a Series of LF Projects, LLC.
4
191
 
5
192
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
193
  of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +206,11 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
206
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
207
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
208
  SOFTWARE.
209
+
210
+ ---
211
+
212
+ Creative Commons Attribution 4.0 International (CC-BY-4.0)
213
+
214
+ Documentation in this project (excluding specifications) is licensed under
215
+ CC-BY-4.0. See https://creativecommons.org/licenses/by/4.0/legalcode for
216
+ the full license text.
package/README.md CHANGED
@@ -1,153 +1,158 @@
1
- # VeriScope MCP Server (@veriscope/mcp-server)
1
+ # MCP Registry
2
2
 
3
- > **VeriScope** is a sovereign cryptographic bibliographic index and citation verification engine for AI Agents. It anchors AI Task Planners in verified scholarly editions across 24 disciplines with **exact chapter coordinates**, **verbatim fair-use excerpts (<=300 chars)**, **64-bit SHA-256 edition hashes**, and **Ed25519 tamper-proof digital receipts (`vsk_sig`)**.
3
+ The MCP registry provides MCP clients with a list of MCP servers, like an app store for MCP servers.
4
4
 
5
- [![MCP Standard](https://img.shields.io/badge/MCP-1.1.0-blue.svg)](https://modelcontextprotocol.io)
6
- [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
7
- [![Zero-Config Sandbox](https://img.shields.io/badge/Sandbox-50_Canons_Offline-brightgreen.svg)](#zero-config-golden-sandbox)
8
- [![Dual-Track Pricing](https://img.shields.io/badge/Pricing-Payoneer_%7C_WeChat_%7C_Alipay-orange.svg)](#dual-track-pricing--access-tiers)
5
+ [**📤 Publish my MCP server**](docs/modelcontextprotocol-io/quickstart.mdx) | [**⚡️ Live API docs**](https://registry.modelcontextprotocol.io/docs) | [**👀 Ecosystem vision**](docs/design/ecosystem-vision.md) | 📖 **[Full documentation](./docs)**
9
6
 
10
- ---
7
+ ## Development Status
11
8
 
12
- ## 🌟 Why VeriScope? Four High-Impact Scenarios (Academic & Executive Strategy)
13
-
14
- When AI Agents conduct research or draft strategic memos, general-purpose LLMs generate plausible yet ungrounded citations, saturate drafts with generic corporate clichés ("AI slop"), or flatten vigorous intellectual conflicts into milquetoast compromises. VeriScope provides a **deterministic factual & dialectical anchor**:
15
-
16
- ### Scenario 1: Max Weber Citation Verification (*The Protestant Ethic*)
17
- * **The Task**: "Cite Max Weber's precise German-to-English thesis on the spirit of capitalism and its ascetic calling."
18
- * ❌ **Vanilla LLM (Hallucinated)**:
19
- > "Weber writes in Chapter 2, page 181: 'The modern capitalist spirit arose purely from Calvinist predestination.' (Weber, 1905, Scribner edition)."
20
- > *Audit*: Fabricated page number; inaccurate quotation; no cryptographic edition hash.
21
- * ✅ **VeriScope MCP (`veriscope_locate_evidence`)**:
22
- > **Edition**: *The Protestant Ethic and the Spirit of Capitalism* (Archival ID: Sovereign Harbor Verified Edition)
23
- > **Coordinate**: Section 2: "The Spirit of Capitalism", Paragraph 12
24
- > **Verbatim Excerpt (<=300 chars)**: *"Man is dominated by the making of money, by acquisition as the ultimate purpose of his life. Economic acquisition is no longer subordinated to man as the means for the satisfaction of his material needs."*
25
- > **Edition SHA-256**: `d7a8fbb5628549...3984e1`
26
- > **Receipt**: `vsk_sig:ed25519_8f0a2e...` (Cryptographically verified against tamper-lock)
27
-
28
- ---
29
-
30
- ### Scenario 2: Hans Kelsen vs. Carl Schmitt on Legal Sovereignty
31
- * **The Task**: "Contrast Hans Kelsen's Pure Theory of Law with Carl Schmitt's Decisionism regarding the State of Exception."
32
- * ❌ **Vanilla LLM (Flat Synthesis)**:
33
- > "Both scholars contributed to German legal theory. Kelsen believed in the rule of law and the Basic Norm, while Schmitt emphasized political authority during crises. They represent complementary aspects of jurisprudence."
34
- > *Audit*: Flattens an irreconcilable Weimar constitutional duel into false harmony.
35
- * ✅ **VeriScope MCP (`veriscope_inspect_topography`)**:
36
- > **Formal Kernel**: Pure normativism (*Reine Rechtslehre*) vs. Political existential decisionism (*Dezisionismus*).
37
- > **Lineages**: Hans Kelsen (Wikidata Q84322) vs. Carl Schmitt (Wikidata Q57476).
38
- > **Dialectical Disputes (3 Core Theses)**:
39
- > 1. *Norm vs. Exception*: Kelsen posits law as a self-contained hierarchy deriving validity solely from the Grundnorm; Schmitt counters that the sovereign is "he who decides on the exception" (*Ausnahmezustand*), where norm yields to concrete order.
40
- > 2. *Guardian of the Constitution*: Kelsen's 1928 constitutional court doctrine vs. Schmitt's 1931 *Der Huter der Verfassung* asserting the Reich President as sole guardian.
41
- > 3. *Validity vs. Facticity*: Logical purity of legal norms versus existential political will.
42
-
43
- ---
44
-
45
- ### Scenario 3: Keynesian Liquidity Trap (*General Theory*)
46
- * **The Task**: "Explain the exact institutional boundary of Keynes's liquidity trap and verify against primary economic texts."
47
- * ❌ **Vanilla LLM (Secondary Paraphrase)**:
48
- > "Keynes explained that when interest rates are zero, monetary policy becomes ineffective because people hold cash."
49
- * ✅ **VeriScope MCP (`veriscope_locate_evidence` & `veriscope_verify_attestation`)**:
50
- > **Formal Axiom**: Absolute liquidity preference under asymptotic flat LM-curve conditions where $\partial M / \partial r \to \infty$.
51
- > **Primary Location**: *The General Theory of Employment, Interest and Money*, Chapter 15 ("The Psychological and Business Incentives to Liquidity"), Section II.
52
- > **Verification Status**: `VERIFIED_AUTHENTIC` (SHA-256 matched with primary English edition).
53
-
54
- ---
55
-
56
- ### Scenario 4: Executive Briefing Elevation & Pre-Mortem Red-Teaming (De-Slop & Grounding)
57
- * **The Task**: "De-slop this corporate proposal on organizational friction, elevate it to first-principles institutional economics, and run a pre-mortem red-team audit before the board review."
58
- * ❌ **Vanilla LLM (Generic Corporate Slop)**:
59
- > "We must break down silos, leverage digital synergies, and align cross-functional stakeholders to drive end-to-end transformation."
60
- * ✅ **VeriScope MCP (`veriscope_discover_concepts` / `veriscope_inspect_topography` / `veriscope_locate_evidence`)**:
61
- > **First-Principles Elevation**: Maps colloquial "silos and red tape" to Max Weber's **Iron Cage of Bureaucracy (`VS-SOC-001`)** and Coasean **Transaction Cost Economics (`VS-ECON-004`)**.
62
- > **Pre-Mortem Red-Team Challenges**: Exposes 3 structural blind spots (e.g., why adding digital coordination layers without altering incentive compatibility increases internal transaction friction).
63
- > **Attested Grounding**: Anchors the executive memo with a <=300-char primary excerpt and Ed25519 receipt (`vsk_sig`).
64
-
65
- ---
66
-
67
- ## 🛠️ The 4+1+1 Cognitive Funnel Tool Matrix (with Citation Audit) (with Business Routing Aliases)
68
-
69
- | Tool Name ( & Business Alias) | Input Parameters | Primary Output | Use Case |
70
- | :--- | :--- | :--- | :--- |
71
- | `veriscope_discover_concepts`<br>*(Alias: `veriscope_business_frame`)* | `query: str`, `discipline_hint?: str` | Standardized canonical ontology, formal definition, Sino-Western comparative counterpart | Elevate colloquial concepts, workplace pain points, or news metaphors into formal academic & strategic frameworks |
72
- | `veriscope_inspect_topography`<br>*(Alias: `veriscope_redteam_audit`)* | `concept_id: str` | `formal_kernel`, Wikidata QIDs, and 3+ structured `dialectical_disputes` | Pre-mortem red-teaming; prevent shallow syntheses; ground the agent in rival axioms and blind spots |
73
- | `veriscope_locate_evidence`<br>*(Alias: `veriscope_deslop_and_ground`)* | `concept_id: str`, `proposition?: str` | Verbatim fair-use slice (**<=300 chars**), chapter coordinate, 64-bit SHA-256, Ed25519 receipt | Replace synthetic AI filler with attested primary editions and peer-reviewable cryptographic proof |
74
- | `veriscope_verify_attestation` | `concept_id: str`, `claimed_sha256: str`, `verbatim_slice?: str` | `is_valid: bool`, `verification_status: "VERIFIED_AUTHENTIC" \| "TAMPER_DETECTED"` | Zero-knowledge cryptographic check for citations, journal peer review, and compliance fact auditing |
75
- | `veriscope_probe_radar` | `concept_id: str` | Cross-disciplinary synaptic radar links, epistemological blind spots | Interdisciplinary research, cognitive blind spot alerts, and synthetic conceptual discovery |
76
- | `veriscope_citation_audit` | `text: str`, `discipline_hint?: str` | Extracted citations, author alignment, SHA-256 grounding, health score (0-100), hallucination detection | **AI Citation Health Check**: Fast-scan drafts to detect fabricated AI citations and misattributions |
77
-
78
- ---
79
-
80
- ## ⚡ Zero-Config Golden Sandbox
81
-
82
- VeriScope ships with a **built-in 50-Canon Golden Sandbox** (`golden_sandbox_50.json`, ~126 KB).
83
-
84
- * **Instant Offline Exploration**: Reviewers and developers can inspect, locate, and verify citations immediately upon installation **without signing up or providing any API key**.
85
- * **10 Disciplines x 5 Canons**: Covers Philosophy (Kant, Plato, Descartes, Nietzsche, Spinoza), Sociology (Weber, Durkheim, Marx, Simmel, Parsons), Political Theory (Schmitt, Hobbes, Locke, Machiavelli, Rawls), Economics (Keynes, Smith, Hayek, Schumpeter, Ricardo), Law (Kelsen, Hart, Dworkin, Fuller, Savigny), History, Literature, Psychology, Communication, and Philosophy of Science (Kuhn, Popper, Lakatos, Feyerabend, Merton).
86
- * **Teaser Mode for Long-Tail Canons**: When querying concepts beyond the 50 sandbox canons without an API key, VeriScope **does not crash with a 401 error**. Instead, it returns a **Cryptographic Teaser Preview** containing the matched canon title, chapter coordinate, and a non-empty `canon_sha256_prefix`, keeping the Agent's reasoning workflow alive.
87
-
88
- ---
89
-
90
- ## 💳 Dual-Track Pricing & Access Tiers
91
-
92
- VeriScope utilizes a **hybrid subscription and credit-pack model** designed to eliminate per-call micro-payment anxiety for automated research pipelines:
93
-
94
- | Plan / Tier | Target Audience | Domestic Pricing (WeChat / Alipay) | Global Pricing (Payoneer Checkout) | Included Quota / Benefits |
95
- | :--- | :--- | :--- | :--- | :--- |
96
- | **Community Sandbox** | Developers & Evaluators | **Free (¥0)** | **Free ($0)** | 50 Golden Canons full access + Teaser previews for all long-tail concepts |
97
- | **Scholar Pro** | Researchers & PhD Candidates | **¥128 / month** | **$19 / month** | Unlimited standard queries, 5,000 evidence slices/mo, full Ed25519 attestation receipts |
98
- | **Power Credit Pack** | Agent Builders & Automated Pipelines | **¥68 / 500 credits** | **$10 / 500 credits** | Flexible top-up for high-frequency automated batch synthesis |
99
- | **Enterprise / Institution** | Academic Labs & Law Firms | **¥5,000 / year** | **$800 / year** | Dedicated rate limits, IP whitelist, institutional co-signing keys, SLA guarantee |
100
-
101
- *To activate your key, visit [https://veriscope.cc/pricing](https://veriscope.cc/pricing) or configure `VERISCOPE_API_KEY`.*
102
-
103
- ---
104
-
105
- ## 🚀 Quick Start & Integration
106
-
107
- ### Claude Desktop / Claude Code
108
- Add to your `claude_desktop_config.json`:
109
- ```json
110
- {
111
- "mcpServers": {
112
- "veriscope": {
113
- "command": "npx",
114
- "args": ["-y", "@veriscope/mcp-server"],
115
- "env": {
116
- "VERISCOPE_API_KEY": "vsk_live_optional_your_key_here"
117
- }
118
- }
119
- }
120
- }
9
+ **2025-10-24 update**: The Registry API has entered an **API freeze (v0.1)** 🎉. For the next month or more, the API will remain stable with no breaking changes, allowing integrators to confidently implement support. This freeze applies to v0.1 while development continues on v0. We'll use this period to validate the API in real-world integrations and gather feedback to shape v1 for general availability. Thank you to everyone for your contributions and patience—your involvement has been key to getting us here!
10
+
11
+ **2025-09-08 update**: The registry has launched in preview 🎉 ([announcement blog post](https://blog.modelcontextprotocol.io/posts/2025-09-08-mcp-registry-preview/)). While the system is now more stable, this is still a preview release and breaking changes or data resets may occur. A general availability (GA) release will follow later. We'd love your feedback in [GitHub discussions](https://github.com/modelcontextprotocol/registry/discussions/new?category=ideas) or in the [#registry-dev Discord](https://discord.com/channels/1358869848138059966/1369487942862504016) ([joining details here](https://modelcontextprotocol.io/community/communication)).
12
+
13
+ Registry Working Group:
14
+ - **Radoslav (Rado) Dimitrov** (Stacklok) [@rdimitrov](https://github.com/rdimitrov) - WG Lead
15
+ - **Tadas Antanavicius** (PulseMCP) [@tadasant](https://github.com/tadasant)
16
+ - **Bob Dickinson** (TeamSpark) [@BobDickinson](https://github.com/BobDickinson)
17
+ - **Preeti (Pree) Dewani** (Ravenmail) [@pree-dew](https://github.com/pree-dew)
18
+
19
+ ## Contributing
20
+
21
+ We use multiple channels for collaboration - see [modelcontextprotocol.io/community/communication](https://modelcontextprotocol.io/community/communication).
22
+
23
+ Often (but not always) ideas flow through this pipeline:
24
+
25
+ - **[Discord](https://modelcontextprotocol.io/community/communication)** - Real-time community discussions
26
+ - **[Discussions](https://github.com/modelcontextprotocol/registry/discussions)** - Propose and discuss product/technical requirements
27
+ - **[Issues](https://github.com/modelcontextprotocol/registry/issues)** - Track well-scoped technical work
28
+ - **[Pull Requests](https://github.com/modelcontextprotocol/registry/pulls)** - Contribute work towards issues
29
+
30
+ ### Quick start:
31
+
32
+ #### Pre-requisites
33
+
34
+ - **Docker**
35
+ - **Go** - version per the `go` directive in [go.mod](./go.mod); the Go toolchain fetches it for you
36
+ - **ko** - Container image builder for Go ([installation instructions](https://ko.build/install/))
37
+ - **golangci-lint** - version per the `golangci-lint-action` pin in [ci.yml](./.github/workflows/ci.yml), so local lint matches CI
38
+
39
+ #### Running the server
40
+
41
+ ```bash
42
+ # Start full development environment
43
+ make dev-compose
44
+ ```
45
+
46
+ This starts the registry at [`localhost:8080`](http://localhost:8080) with PostgreSQL. The database uses ephemeral storage and is reset each time you restart the containers, ensuring a clean state for development and testing.
47
+
48
+ **Note:** The registry uses [ko](https://ko.build) to build container images. The `make dev-compose` command automatically builds the registry image with ko and loads it into your local Docker daemon before starting the services.
49
+
50
+ By default, the registry seeds from the production API with a filtered subset of servers (to keep startup fast). This ensures your local environment mirrors production behavior and all seed data passes validation. For offline development you can seed from a file without validation with `MCP_REGISTRY_SEED_FROM=data/seed.json MCP_REGISTRY_ENABLE_REGISTRY_VALIDATION=false make dev-compose`.
51
+
52
+ The setup can be configured with environment variables in [docker-compose.yml](./docker-compose.yml) - see [.env.example](./.env.example) for a reference.
53
+
54
+ <details>
55
+ <summary>Alternative: Running a pre-built Docker image</summary>
56
+
57
+ Pre-built Docker images are automatically published to GitHub Container Registry. Note that the image does not bundle PostgreSQL, so you need to run your own and point the registry at it via `MCP_REGISTRY_DATABASE_URL` (see [docker-compose.yml](./docker-compose.yml) for a working example):
58
+
59
+ ```bash
60
+ # Run latest stable release
61
+ docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:latest
62
+
63
+ # Run latest from main branch (continuous deployment)
64
+ docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:main
65
+
66
+ # Run specific release version
67
+ docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:v1.0.0
68
+
69
+ # Run development build from main branch
70
+ docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:main-20250906-abc123d
71
+ ```
72
+
73
+ **Available tags:**
74
+ - **Releases**: `latest`, `v1.0.0`, `v1.1.0`, etc.
75
+ - **Continuous**: `main` (latest main branch build)
76
+ - **Development**: `main-<date>-<sha>` (specific commit builds)
77
+
78
+ </details>
79
+
80
+ #### Publishing a server
81
+
82
+ Publishing an MCP server does **not** happen through a pull request to this repository. Adding a `server.json`, a server directory, or an entry in `data/seed.json` will not publish or list your server, even if the PR is merged. Use the `mcp-publisher` CLI from your server's own project instead.
83
+
84
+ To publish a server, we've built a simple CLI. You can use it with:
85
+
86
+ ```bash
87
+ # Build the latest CLI
88
+ make publisher
89
+
90
+ # Use it!
91
+ ./bin/mcp-publisher --help
121
92
  ```
122
93
 
123
- ### Cursor & Windsurf
124
- Add as a new stdio MCP server:
125
- - **Command**: `npx`
126
- - **Arguments**: `-y @veriscope/mcp-server`
127
-
128
- ### Python / uvx Alternative
129
- ```json
130
- {
131
- "mcpServers": {
132
- "veriscope": {
133
- "command": "uvx",
134
- "args": ["veriscope-mcp"]
135
- }
136
- }
137
- }
94
+ See [the publisher guide](./docs/modelcontextprotocol-io/quickstart.mdx) for more details.
95
+
96
+ #### Other commands
97
+
98
+ ```bash
99
+ # Run lint, schema validation, and all tests
100
+ # Note: this also runs `make dev-down`, stopping any running dev-compose environment
101
+ make check
102
+ ```
103
+
104
+ There are also a few more helpful commands for development. Run `make help` to learn more, or look in [Makefile](./Makefile).
105
+
106
+ <!--
107
+ For Claude and other AI tools: Always prefer make targets over custom commands where possible.
108
+ -->
109
+
110
+ ## Architecture
111
+
112
+ ### Project Structure
113
+
138
114
  ```
115
+ ├── cmd/ # Application entry points
116
+ │ ├── publisher/ # Server publishing tool
117
+ │ └── registry/ # Registry API server
118
+ ├── data/ # Seed data
119
+ ├── deploy/ # Deployment configuration (Pulumi)
120
+ ├── docs/ # Documentation
121
+ ├── internal/ # Private application code
122
+ │ ├── api/ # HTTP handlers and routing
123
+ │ ├── auth/ # Authentication (GitHub OAuth, JWT, namespace blocking)
124
+ │ ├── config/ # Configuration management
125
+ │ ├── database/ # Data persistence (PostgreSQL)
126
+ │ ├── importer/ # Seed data import
127
+ │ ├── service/ # Business logic
128
+ │ ├── telemetry/ # Metrics and monitoring
129
+ │ └── validators/ # Input validation
130
+ ├── pkg/ # Public packages
131
+ │ ├── api/ # API types and structures
132
+ │ │ └── v0/ # Version 0 API types
133
+ │ └── model/ # Data models for server.json
134
+ ├── scripts/ # Development and testing scripts
135
+ ├── tests/ # Integration tests
136
+ └── tools/ # CLI tools and utilities
137
+ └── validate-*.sh # Schema validation tools
138
+ ```
139
+
140
+ ### Authentication
139
141
 
140
- ---
142
+ Publishing supports multiple authentication methods:
143
+ - **GitHub OAuth** - For publishing by logging into GitHub
144
+ - **GitHub OIDC** - For publishing from GitHub Actions
145
+ - **DNS verification** - For proving ownership of a domain and its subdomains
146
+ - **HTTP verification** - For proving ownership of a domain
141
147
 
142
- ## 🔒 Security, Privacy & Scholarly Fair-Use Compliance
148
+ The registry validates namespace ownership when publishing. E.g. to publish...:
149
+ - `io.github.domdomegg/my-cool-mcp` you must login to GitHub as `domdomegg`, or be in a GitHub Action on domdomegg's repos
150
+ - `me.adamjones/my-cool-mcp` you must prove ownership of `adamjones.me` via DNS or HTTP challenge
143
151
 
144
- 1. **Read-Only Engine**: VeriScope operates strictly in read-only mode (`mode=ro`). It never writes to the host filesystem.
145
- 2. **Scholarly Fair-Use Doctrine**: VeriScope is a cryptographic bibliographic index and citation verification engine. It never distributes or transmits full book copies; verbatim evidence excerpts are hard-capped at **strictly <=300 characters** around the proposition anchor.
146
- 3. **Cryptographic Ed25519 Receipts**: Every attested quote is signed with the slice's 16-hex hash (`slice_sha256_16`) in the payload `VERISCOPE_ATTESTATION:{concept_id}:{canon_sha256}:{slice_sha16}:{timestamp}`, providing tamper-evident authenticity for scholarly peer review.
147
- 4. **Entropy Rate Limiting (F8 Shield)**: High-entropy scraping attacks triggering cross-disciplinary jumps across $\ge 6$ disciplines in short bursts automatically drop into **Zero-Text Proof Mode** (yielding only coordinates and SHA-256 prefixes), protecting the sovereign archive while maintaining zero-hallucination factual integrity.
152
+ ## Community Projects
148
153
 
149
- ---
154
+ Check out [community projects](docs/community-projects.md) to explore notable registry-related work created by the community.
150
155
 
151
- ## 📄 License
156
+ ## More documentation
152
157
 
153
- MIT License. See [LICENSE](LICENSE) for details.
158
+ See the [documentation](./docs) for more details if your question has not been answered here!