jscdocs 0.2.0__tar.gz → 0.2.1__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 (28) hide show
  1. {jscdocs-0.2.0 → jscdocs-0.2.1}/PKG-INFO +8 -4
  2. {jscdocs-0.2.0 → jscdocs-0.2.1}/README.md +5 -3
  3. {jscdocs-0.2.0 → jscdocs-0.2.1}/pyproject.toml +5 -1
  4. {jscdocs-0.2.0 → jscdocs-0.2.1}/.gitignore +0 -0
  5. {jscdocs-0.2.0 → jscdocs-0.2.1}/LICENSE +0 -0
  6. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/__init__.py +0 -0
  7. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/build.py +0 -0
  8. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/cli.py +0 -0
  9. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/__init__.py +0 -0
  10. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/agent_cli.py +0 -0
  11. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/agent_config.py +0 -0
  12. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/config.py +0 -0
  13. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/crawl.py +0 -0
  14. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/evaluate.py +0 -0
  15. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/extract.py +0 -0
  16. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/fetch.py +0 -0
  17. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/init.py +0 -0
  18. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/inventory.py +0 -0
  19. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/lock.py +0 -0
  20. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/published.py +0 -0
  21. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/refresh.py +0 -0
  22. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/search.py +0 -0
  23. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/sites.py +0 -0
  24. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/store.py +0 -0
  25. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/core/sync.py +0 -0
  26. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/mcp/__init__.py +0 -0
  27. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/mcp/server.py +0 -0
  28. {jscdocs-0.2.0 → jscdocs-0.2.1}/src/jscdocs/mcp/tools.py +0 -0
@@ -1,7 +1,9 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: jscdocs
3
- Version: 0.2.0
3
+ Version: 0.2.1
4
4
  Summary: Search and read the JSC supercomputer user documentation from AI agents: an MCP server and CLI for JURECA, JUWELS, JUSUF, JUPITER, JEDI and JUDAC
5
+ Project-URL: Source, https://gitlab.jsc.fz-juelich.de/sdlaml/agents-on-hpc/jsc-docs-mcp-server
6
+ Project-URL: Issues, https://gitlab.jsc.fz-juelich.de/sdlaml/agents-on-hpc/jsc-docs-mcp-server/-/issues
5
7
  License-Expression: MIT
6
8
  License-File: LICENSE
7
9
  Keywords: ai-agents,documentation,hpc,jupiter,jureca,jusuf,juwels,mcp
@@ -27,12 +29,14 @@ An agent with jscdocs answers questions such as "what is the maximum walltime of
27
29
 
28
30
  ## Install
29
31
 
30
- jscdocs needs Python 3.12 or later. Install it from a clone of this repository:
32
+ jscdocs needs Python 3.12 or later. Install it from PyPI:
31
33
 
32
34
  ```sh
33
- pip install . # or: uv tool install .
35
+ pip install jscdocs # or: uv tool install jscdocs, or: pipx install jscdocs
34
36
  ```
35
37
 
38
+ Upgrade it the same way, with `pip install --upgrade jscdocs` or `uv tool upgrade jscdocs`. To run the code of a clone of this repository instead, install it with `pip install .` in the clone.
39
+
36
40
  Then get the index once:
37
41
 
38
42
  ```sh
@@ -52,7 +56,7 @@ jscdocs init pi --index $PROJECT/$USER/jscdocs/index.sqlite
52
56
  jscdocs init opencode --project # in the current project only, as a file others can share
53
57
  ```
54
58
 
55
- Init uses the agent's own `mcp add` command where that can write the whole entry, and edits the agent's configuration file otherwise. It keeps your other servers and settings, and it never starts the server or downloads anything. [docs/init.md](docs/init.md) describes the options, the files it writes and how it handles entries you edited.
59
+ Init uses the agent's own `mcp add` command where that can write the whole entry, and edits the agent's configuration file otherwise. It keeps your other servers and settings, and it never starts the server or downloads anything. [docs/init.md](https://gitlab.jsc.fz-juelich.de/sdlaml/agents-on-hpc/jsc-docs-mcp-server/-/blob/main/docs/init.md) describes the options, the files it writes and how it handles entries you edited.
56
60
 
57
61
  In Claude Code the tools appear as `mcp__jscdocs__search_docs`, `mcp__jscdocs__read_docs` and `mcp__jscdocs__list_docs`. Any other MCP client, such as Cursor or your own agent, starts `jscdocs-mcp` as a stdio server, for example with `claude mcp add --scope user jscdocs -- jscdocs-mcp` in Claude Code.
58
62
 
@@ -6,12 +6,14 @@ An agent with jscdocs answers questions such as "what is the maximum walltime of
6
6
 
7
7
  ## Install
8
8
 
9
- jscdocs needs Python 3.12 or later. Install it from a clone of this repository:
9
+ jscdocs needs Python 3.12 or later. Install it from PyPI:
10
10
 
11
11
  ```sh
12
- pip install . # or: uv tool install .
12
+ pip install jscdocs # or: uv tool install jscdocs, or: pipx install jscdocs
13
13
  ```
14
14
 
15
+ Upgrade it the same way, with `pip install --upgrade jscdocs` or `uv tool upgrade jscdocs`. To run the code of a clone of this repository instead, install it with `pip install .` in the clone.
16
+
15
17
  Then get the index once:
16
18
 
17
19
  ```sh
@@ -31,7 +33,7 @@ jscdocs init pi --index $PROJECT/$USER/jscdocs/index.sqlite
31
33
  jscdocs init opencode --project # in the current project only, as a file others can share
32
34
  ```
33
35
 
34
- Init uses the agent's own `mcp add` command where that can write the whole entry, and edits the agent's configuration file otherwise. It keeps your other servers and settings, and it never starts the server or downloads anything. [docs/init.md](docs/init.md) describes the options, the files it writes and how it handles entries you edited.
36
+ Init uses the agent's own `mcp add` command where that can write the whole entry, and edits the agent's configuration file otherwise. It keeps your other servers and settings, and it never starts the server or downloads anything. [docs/init.md](https://gitlab.jsc.fz-juelich.de/sdlaml/agents-on-hpc/jsc-docs-mcp-server/-/blob/main/docs/init.md) describes the options, the files it writes and how it handles entries you edited.
35
37
 
36
38
  In Claude Code the tools appear as `mcp__jscdocs__search_docs`, `mcp__jscdocs__read_docs` and `mcp__jscdocs__list_docs`. Any other MCP client, such as Cursor or your own agent, starts `jscdocs-mcp` as a stdio server, for example with `claude mcp add --scope user jscdocs -- jscdocs-mcp` in Claude Code.
37
39
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "jscdocs"
3
- version = "0.2.0"
3
+ version = "0.2.1"
4
4
  description = "Search and read the JSC supercomputer user documentation from AI agents: an MCP server and CLI for JURECA, JUWELS, JUSUF, JUPITER, JEDI and JUDAC"
5
5
  readme = "README.md"
6
6
  license = "MIT"
@@ -19,6 +19,10 @@ classifiers = [
19
19
  "Topic :: Documentation",
20
20
  ]
21
21
 
22
+ [project.urls]
23
+ Source = "https://gitlab.jsc.fz-juelich.de/sdlaml/agents-on-hpc/jsc-docs-mcp-server"
24
+ Issues = "https://gitlab.jsc.fz-juelich.de/sdlaml/agents-on-hpc/jsc-docs-mcp-server/-/issues"
25
+
22
26
  [project.scripts]
23
27
  jscdocs = "jscdocs.cli:main"
24
28
  jscdocs-mcp = "jscdocs.mcp.server:main"
File without changes
File without changes
File without changes
File without changes
File without changes