@digital-science-dsl/dimensions-analytics-mcp 1.0.1 → 1.0.2

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 (3) hide show
  1. package/CHANGELOG.md +3 -6
  2. package/README.md +3 -146
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,9 +1,6 @@
1
1
  # Changelog
2
2
 
3
- ## 1.0.1
3
+ ## 1.0.2
4
4
 
5
- - Install docs: `npx` examples use latest npm package by default (optional `@x.y.z` pin)
6
-
7
- ## 1.0.0
8
-
9
- Initial public release of Dimensions Analytics MCP.
5
+ - Consolidate docs into INSTALLATION, USAGE, and REFERENCE (drop CONFIGURATION.md and IDENTIFIERS.md)
6
+ - Trim package README; tool list in USAGE; hosted coming-soon banner only in root README
package/README.md CHANGED
@@ -1,148 +1,5 @@
1
- # Dimensions Analytics MCP
1
+ # @digital-science-dsl/dimensions-analytics-mcp
2
2
 
3
- Model Context Protocol (MCP) server for the Dimensions Analytics API — enables AI assistants to search and analyze linked research data with the Dimensions DSL.
3
+ Dimensions Analytics MCP server for the Dimensions DSL.
4
4
 
5
- **Transport:** stdio (`dimensions-analytics-mcp`) for local use. A hosted remote option (URL + Bearer token) is **coming soon** see [Installation — Hosted Dimensions Analytics MCP](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/INSTALLATION.md#hosted-dimensions-analytics-mcp-coming-soon).
6
-
7
- ## What It Does
8
-
9
- Dimensions Analytics MCP provides access to Dimensions, the world's largest linked research information database with over 140M publications, grants, patents, clinical trials, and more. It enables Claude and other MCP-compatible AI assistants to search and analyze research data.
10
-
11
- ## Available Tools
12
-
13
- ### Search Tools
14
-
15
- | Tool | Description |
16
- | ---- | ----------- |
17
- | `search_publications` | Search research articles, preprints, and books with citation metrics |
18
- | `search_grants` | Search research grants and funding awards |
19
- | `search_researchers` | Search researcher profiles with publication counts and affiliations |
20
- | `search_patents` | Search patents with assignee and filing information |
21
- | `search_clinical_trials` | Search clinical trials by phase, condition, or status |
22
- | `search_datasets` | Search research datasets and repositories |
23
- | `search_policy_documents` | Search policy briefs and government documents |
24
- | `search_organizations` | Search universities, research institutes, and companies |
25
- | `fetch_search_pages` | Paginated / batch search (page, aggregate, JSONL/CSV file export) — **local stdio only** |
26
-
27
- ### Lookup Tools
28
-
29
- | Tool | Description |
30
- | ---- | ----------- |
31
- | `get_by_doi` | Retrieve publication by DOI |
32
- | `get_by_pmid` | Retrieve publication by PubMed ID |
33
- | `get_by_id` | Retrieve any entity by Dimensions ID |
34
-
35
- ### Analytics & Trend Tools
36
-
37
- | Tool | Description |
38
- | ---- | ----------- |
39
- | `aggregate_query` | Numeric aggregation (sum/avg/count) over any entity with grouping |
40
- | `facet_query` | Facet counts for top values of any field |
41
- | `citation_trend` | Citation counts over time for a topic or entity |
42
- | `funding_trend` | Funding awarded over time for a topic or entity |
43
-
44
- ### Entity Resolution Tools
45
-
46
- | Tool | Description |
47
- | ---- | ----------- |
48
- | `extract_affiliations` | Resolve organization affiliations to GRID/ROR identifiers |
49
- | `extract_grants` | Resolve grant numbers to full grant records |
50
- | `execute_dsl` | Execute raw Dimensions DSL queries (classify, extract concepts, similarity, KWQ, and more) |
51
-
52
- ### Schema Tools
53
-
54
- | Tool | Description |
55
- | ---- | ----------- |
56
- | `describe_schema` | Summarize live describe schema (sources, entities, limits) |
57
- | `refresh_schema` | Reload describe schema from the API |
58
-
59
- ## Quick Start
60
-
61
- **Easiest** — one-line install (no clone required):
62
-
63
- ```bash
64
- curl -fsSL https://raw.githubusercontent.com/digital-science/dimensions-analytics-mcp/main/scripts/install.sh | bash
65
- ```
66
-
67
- ```powershell
68
- irm https://raw.githubusercontent.com/digital-science/dimensions-analytics-mcp/main/scripts/install.ps1 | iex
69
- ```
70
-
71
- See [Installation](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/INSTALLATION.md) for manual setup.
72
-
73
- ### Build from source (developers)
74
-
75
- ```bash
76
- pnpm install
77
- pnpm run build
78
- export DIMENSIONS_API_KEY=your-key
79
- node apps/mcp/dist/main.js # stdio
80
- ```
81
-
82
- ### Claude Desktop (stdio)
83
-
84
- ```json
85
- {
86
- "mcpServers": {
87
- "dimensions": {
88
- "command": "node",
89
- "args": ["/path/to/dimensions-analytics-mcp/apps/mcp/dist/main.js"],
90
- "env": {
91
- "DIMENSIONS_API_KEY": "your-api-key"
92
- }
93
- }
94
- }
95
- }
96
- ```
97
-
98
- ### Hosted remote MCP (coming soon)
99
-
100
- A hosted Dimensions Analytics MCP endpoint (URL + Bearer token, no local install) is **not available yet**. We will announce it in the near future. See [Installation — Hosted Dimensions Analytics MCP](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/INSTALLATION.md#hosted-dimensions-analytics-mcp-coming-soon).
101
-
102
- ## Examples and usage
103
-
104
- **[Usage guide](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/USAGE.md)** — workflows, JSON tool examples, DSL snippets, and natural-language prompts.
105
-
106
- Quick prompt examples:
107
-
108
- ```text
109
- Find the top 10 most-cited publications about CRISPR from the last 5 years
110
- ```
111
-
112
- ```text
113
- Facet journals for "quantum computing" publications since 2020
114
- ```
115
-
116
- ## Documentation
117
-
118
- **This package**
119
-
120
- - [Usage guide](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/USAGE.md) — **start here** for examples
121
- - [Deployment](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/DEPLOYMENT.md) — local stdio setup; hosted option (coming soon)
122
- - [Configuration](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/CONFIGURATION.md) — env vars
123
- - [MCP field aliases](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/MCP_FIELD_ALIASES.md) — alias reference for tool users
124
-
125
- **Repository** ([dimensions-analytics-mcp](https://github.com/digital-science/dimensions-analytics-mcp))
126
-
127
- - [Root README](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/README.md)
128
- - [Installation](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/INSTALLATION.md)
129
-
130
- **External**
131
-
132
- - [Dimensions API Docs](https://docs.dimensions.ai/)
133
- - [Model Context Protocol spec](https://modelcontextprotocol.io/)
134
-
135
- ## Development
136
-
137
- ```bash
138
- pnpm install # from repo root
139
- pnpm run build
140
-
141
- pnpm run test # unit + mock hosted e2e
142
- pnpm run integration:smoke # live stdio smoke (DIMENSIONS_API_KEY)
143
- pnpm run typecheck
144
- ```
145
-
146
- ## License
147
-
148
- MIT
5
+ **Documentation:** [github.com/digital-science/dimensions-analytics-mcp](https://github.com/digital-science/dimensions-analytics-mcp) — [Installation](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/INSTALLATION.md), [Usage](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/USAGE.md), [Reference](https://github.com/digital-science/dimensions-analytics-mcp/blob/main/docs/REFERENCE.md).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital-science-dsl/dimensions-analytics-mcp",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Dimensions Analytics MCP server for Dimensions DSL querying",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",