querycleaner 0.1.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 (132) hide show
  1. querycleaner-0.1.0/.github/workflows/ci.yml +100 -0
  2. querycleaner-0.1.0/.github/workflows/release.yml +65 -0
  3. querycleaner-0.1.0/.gitignore +19 -0
  4. querycleaner-0.1.0/.rtk/filters.toml +13 -0
  5. querycleaner-0.1.0/.serena/.gitignore +2 -0
  6. querycleaner-0.1.0/.serena/project.yml +168 -0
  7. querycleaner-0.1.0/CLAUDE.md +10 -0
  8. querycleaner-0.1.0/LICENSE +202 -0
  9. querycleaner-0.1.0/PKG-INFO +645 -0
  10. querycleaner-0.1.0/README.md +613 -0
  11. querycleaner-0.1.0/SECURITY.md +114 -0
  12. querycleaner-0.1.0/SPEC.md +1607 -0
  13. querycleaner-0.1.0/docs/adr/001-name-and-license.md +45 -0
  14. querycleaner-0.1.0/docs/adr/002-mcp-sdk.md +23 -0
  15. querycleaner-0.1.0/docs/adr/003-auth-and-secrets.md +34 -0
  16. querycleaner-0.1.0/docs/adr/004-local-state.md +22 -0
  17. querycleaner-0.1.0/docs/adr/005-no-dp-in-v1.md +25 -0
  18. querycleaner-0.1.0/docs/adr/006-jdbc-bridge.md +48 -0
  19. querycleaner-0.1.0/docs/adr/007-predicates-and-cancellation.md +40 -0
  20. querycleaner-0.1.0/docs/connectors.md +253 -0
  21. querycleaner-0.1.0/docs/gaps.md +185 -0
  22. querycleaner-0.1.0/docs/mcp.md +196 -0
  23. querycleaner-0.1.0/docs/operations.md +238 -0
  24. querycleaner-0.1.0/docs/policies.md +125 -0
  25. querycleaner-0.1.0/docs/profiling.md +192 -0
  26. querycleaner-0.1.0/docs/synthetic-data.md +102 -0
  27. querycleaner-0.1.0/pyproject.toml +89 -0
  28. querycleaner-0.1.0/src/qc/__init__.py +4 -0
  29. querycleaner-0.1.0/src/qc/application/__init__.py +1 -0
  30. querycleaner-0.1.0/src/qc/application/cancellation.py +54 -0
  31. querycleaner-0.1.0/src/qc/application/exports.py +128 -0
  32. querycleaner-0.1.0/src/qc/application/generation.py +439 -0
  33. querycleaner-0.1.0/src/qc/application/job_runner.py +163 -0
  34. querycleaner-0.1.0/src/qc/application/jobs.py +221 -0
  35. querycleaner-0.1.0/src/qc/application/runtime.py +105 -0
  36. querycleaner-0.1.0/src/qc/application/sanitize.py +318 -0
  37. querycleaner-0.1.0/src/qc/application/sources.py +79 -0
  38. querycleaner-0.1.0/src/qc/artifacts/__init__.py +1 -0
  39. querycleaner-0.1.0/src/qc/artifacts/profiles.py +104 -0
  40. querycleaner-0.1.0/src/qc/cli/__init__.py +1 -0
  41. querycleaner-0.1.0/src/qc/cli/app.py +1222 -0
  42. querycleaner-0.1.0/src/qc/cli/present.py +102 -0
  43. querycleaner-0.1.0/src/qc/config/__init__.py +29 -0
  44. querycleaner-0.1.0/src/qc/config/loader.py +199 -0
  45. querycleaner-0.1.0/src/qc/config/policies.py +158 -0
  46. querycleaner-0.1.0/src/qc/connectors/__init__.py +1 -0
  47. querycleaner-0.1.0/src/qc/connectors/base.py +178 -0
  48. querycleaner-0.1.0/src/qc/connectors/fixture.py +364 -0
  49. querycleaner-0.1.0/src/qc/connectors/google_sheets.py +503 -0
  50. querycleaner-0.1.0/src/qc/connectors/lark_sheets.py +441 -0
  51. querycleaner-0.1.0/src/qc/connectors/maxcompute.py +421 -0
  52. querycleaner-0.1.0/src/qc/connectors/mysql.py +572 -0
  53. querycleaner-0.1.0/src/qc/connectors/pool.py +113 -0
  54. querycleaner-0.1.0/src/qc/connectors/postgres.py +596 -0
  55. querycleaner-0.1.0/src/qc/connectors/registry.py +76 -0
  56. querycleaner-0.1.0/src/qc/connectors/resilience.py +128 -0
  57. querycleaner-0.1.0/src/qc/connectors/sheet_normalize.py +315 -0
  58. querycleaner-0.1.0/src/qc/connectors/sql_common.py +235 -0
  59. querycleaner-0.1.0/src/qc/connectors/sqlite_conn.py +733 -0
  60. querycleaner-0.1.0/src/qc/domain/__init__.py +139 -0
  61. querycleaner-0.1.0/src/qc/domain/cancellation.py +50 -0
  62. querycleaner-0.1.0/src/qc/domain/enums.py +262 -0
  63. querycleaner-0.1.0/src/qc/domain/errors.py +116 -0
  64. querycleaner-0.1.0/src/qc/domain/models.py +551 -0
  65. querycleaner-0.1.0/src/qc/domain/predicate.py +174 -0
  66. querycleaner-0.1.0/src/qc/exports/__init__.py +1 -0
  67. querycleaner-0.1.0/src/qc/exports/csv_writer.py +65 -0
  68. querycleaner-0.1.0/src/qc/exports/db_writer.py +232 -0
  69. querycleaner-0.1.0/src/qc/exports/jsonl.py +70 -0
  70. querycleaner-0.1.0/src/qc/generation/__init__.py +1 -0
  71. querycleaner-0.1.0/src/qc/generation/strategies.py +410 -0
  72. querycleaner-0.1.0/src/qc/generation/validation.py +247 -0
  73. querycleaner-0.1.0/src/qc/jdbc_bridge/__init__.py +22 -0
  74. querycleaner-0.1.0/src/qc/jdbc_bridge/client.py +370 -0
  75. querycleaner-0.1.0/src/qc/jdbc_bridge/protocol.py +178 -0
  76. querycleaner-0.1.0/src/qc/jdbc_bridge/sidecar/BUILD.md +62 -0
  77. querycleaner-0.1.0/src/qc/jdbc_bridge/sidecar/driver-lock.json +11 -0
  78. querycleaner-0.1.0/src/qc/jdbc_bridge/sidecar/src/qc/jdbc/Main.java +535 -0
  79. querycleaner-0.1.0/src/qc/mcp/__init__.py +1 -0
  80. querycleaner-0.1.0/src/qc/mcp/__main__.py +40 -0
  81. querycleaner-0.1.0/src/qc/mcp/metadata.py +155 -0
  82. querycleaner-0.1.0/src/qc/mcp/schemas.py +257 -0
  83. querycleaner-0.1.0/src/qc/mcp/server.py +222 -0
  84. querycleaner-0.1.0/src/qc/mcp/service.py +666 -0
  85. querycleaner-0.1.0/src/qc/observability/__init__.py +5 -0
  86. querycleaner-0.1.0/src/qc/observability/logging.py +138 -0
  87. querycleaner-0.1.0/src/qc/observability/metrics.py +132 -0
  88. querycleaner-0.1.0/src/qc/profiling/__init__.py +1 -0
  89. querycleaner-0.1.0/src/qc/profiling/engine.py +902 -0
  90. querycleaner-0.1.0/src/qc/profiling/falsy.py +166 -0
  91. querycleaner-0.1.0/src/qc/profiling/relationships.py +98 -0
  92. querycleaner-0.1.0/src/qc/profiling/type_inference.py +371 -0
  93. querycleaner-0.1.0/src/qc/sanitization/__init__.py +1 -0
  94. querycleaner-0.1.0/src/qc/sanitization/actions.py +140 -0
  95. querycleaner-0.1.0/src/qc/security/__init__.py +45 -0
  96. querycleaner-0.1.0/src/qc/security/audit.py +106 -0
  97. querycleaner-0.1.0/src/qc/security/policy.py +264 -0
  98. querycleaner-0.1.0/src/qc/security/redaction.py +80 -0
  99. querycleaner-0.1.0/src/qc/security/secrets.py +158 -0
  100. querycleaner-0.1.0/src/qc/security/sensitivity.py +291 -0
  101. querycleaner-0.1.0/tests/conftest.py +337 -0
  102. querycleaner-0.1.0/tests/contract/__init__.py +1 -0
  103. querycleaner-0.1.0/tests/contract/fake_sidecar.py +175 -0
  104. querycleaner-0.1.0/tests/contract/test_connector_contract.py +260 -0
  105. querycleaner-0.1.0/tests/contract/test_fixture_profiling.py +247 -0
  106. querycleaner-0.1.0/tests/contract/test_jdbc_bridge.py +274 -0
  107. querycleaner-0.1.0/tests/contract/test_sheets.py +488 -0
  108. querycleaner-0.1.0/tests/e2e/__init__.py +1 -0
  109. querycleaner-0.1.0/tests/e2e/test_cli_journeys.py +468 -0
  110. querycleaner-0.1.0/tests/e2e/test_mcp_stdio.py +439 -0
  111. querycleaner-0.1.0/tests/integration/__init__.py +1 -0
  112. querycleaner-0.1.0/tests/integration/test_db_export.py +291 -0
  113. querycleaner-0.1.0/tests/integration/test_predicate_live.py +115 -0
  114. querycleaner-0.1.0/tests/property/__init__.py +1 -0
  115. querycleaner-0.1.0/tests/property/test_properties.py +441 -0
  116. querycleaner-0.1.0/tests/security/__init__.py +1 -0
  117. querycleaner-0.1.0/tests/security/test_security.py +395 -0
  118. querycleaner-0.1.0/tests/unit/__init__.py +1 -0
  119. querycleaner-0.1.0/tests/unit/test_cancellation.py +287 -0
  120. querycleaner-0.1.0/tests/unit/test_config.py +128 -0
  121. querycleaner-0.1.0/tests/unit/test_mcp_result.py +37 -0
  122. querycleaner-0.1.0/tests/unit/test_output_formats.py +98 -0
  123. querycleaner-0.1.0/tests/unit/test_policy.py +184 -0
  124. querycleaner-0.1.0/tests/unit/test_predicate_pool.py +150 -0
  125. querycleaner-0.1.0/tests/unit/test_resilience_metrics.py +184 -0
  126. querycleaner-0.1.0/tests/unit/test_security.py +134 -0
  127. querycleaner-0.1.0/tests/unit/test_sqlite_connector.py +539 -0
  128. querycleaner-0.1.0/tests/unit/test_tool_annotations.py +42 -0
  129. querycleaner-0.1.0/tests/unit/test_tools_metadata.py +112 -0
  130. querycleaner-0.1.0/tests/unit/test_type_inference.py +170 -0
  131. querycleaner-0.1.0/tools/make_demo_db.py +303 -0
  132. querycleaner-0.1.0/uv.lock +1360 -0
@@ -0,0 +1,100 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ jobs:
9
+ checks:
10
+ runs-on: ubuntu-latest
11
+ strategy:
12
+ matrix:
13
+ python-version: ["3.12", "3.13"]
14
+ steps:
15
+ - uses: actions/checkout@v4
16
+ - uses: astral-sh/setup-uv@v5
17
+ with:
18
+ python-version: ${{ matrix.python-version }}
19
+ - name: Sync dependencies
20
+ run: uv sync --locked
21
+ - name: Lint
22
+ run: uv run ruff check src tests
23
+ - name: Format check
24
+ run: uv run ruff format --check src tests
25
+ - name: Type check
26
+ run: uv run mypy
27
+ - name: Unit & property tests
28
+ run: uv run pytest tests/unit tests/property tests/security -q
29
+ - name: Contract tests (no external services)
30
+ # fixture, fake/bridge, and sqlite need no server, so they run here
31
+ run: uv run pytest tests/contract -q -k "fixture or fake or bridge or sqlite"
32
+
33
+ package:
34
+ # Build the sdist+wheel and validate the metadata, so packaging regressions
35
+ # surface on a PR instead of at release time.
36
+ runs-on: ubuntu-latest
37
+ steps:
38
+ - uses: actions/checkout@v4
39
+ - uses: astral-sh/setup-uv@v5
40
+ with:
41
+ python-version: "3.12"
42
+ - name: Build
43
+ run: uv build
44
+ - name: Validate the distribution metadata
45
+ run: uvx twine check dist/*
46
+
47
+ e2e:
48
+ # End-to-end CLI journeys + the real MCP stdio server. No external services
49
+ # (the server is spawned locally), so this runs on every push/PR.
50
+ runs-on: ubuntu-latest
51
+ needs: checks
52
+ steps:
53
+ - uses: actions/checkout@v4
54
+ - uses: astral-sh/setup-uv@v5
55
+ with:
56
+ python-version: "3.12"
57
+ - run: uv sync --locked
58
+ - name: End-to-end tests
59
+ run: uv run pytest tests/e2e -q
60
+
61
+ integration-db:
62
+ runs-on: ubuntu-latest
63
+ needs: checks
64
+ services:
65
+ postgres:
66
+ image: postgres:16
67
+ env:
68
+ POSTGRES_PASSWORD: qc_test
69
+ POSTGRES_USER: qc_test
70
+ POSTGRES_DB: qc_test
71
+ ports: ["5432:5432"]
72
+ options: >-
73
+ --health-cmd "pg_isready -U qc_test"
74
+ --health-interval 5s
75
+ --health-timeout 5s
76
+ --health-retries 10
77
+ mysql:
78
+ image: mysql:8.4
79
+ env:
80
+ MYSQL_ROOT_PASSWORD: qc_test
81
+ MYSQL_DATABASE: qc_test
82
+ MYSQL_USER: qc_test
83
+ MYSQL_PASSWORD: qc_test
84
+ ports: ["3306:3306"]
85
+ options: >-
86
+ --health-cmd "mysqladmin ping -h localhost"
87
+ --health-interval 5s
88
+ --health-timeout 5s
89
+ --health-retries 20
90
+ env:
91
+ QC_TEST_POSTGRES_DSN: postgresql://qc_test:qc_test@127.0.0.1:5432/qc_test
92
+ QC_TEST_MYSQL_DSN: mysql://qc_test:qc_test@127.0.0.1:3306/qc_test
93
+ steps:
94
+ - uses: actions/checkout@v4
95
+ - uses: astral-sh/setup-uv@v5
96
+ with:
97
+ python-version: "3.12"
98
+ - run: uv sync --locked
99
+ - name: Connector contract tests (live)
100
+ run: uv run pytest tests/integration tests/contract -q -m integration
@@ -0,0 +1,65 @@
1
+ name: Release
2
+
3
+ # Publish the `querycleaner` distribution to PyPI via **Trusted Publishing**
4
+ # (OIDC) — no API token is stored in the repo.
5
+ #
6
+ # One-time setup on PyPI — https://pypi.org/manage/account/publishing/ :
7
+ # PyPI project name : querycleaner
8
+ # Owner : adaptivemcp
9
+ # Repository : qc
10
+ # Workflow name : release.yml
11
+ # Environment : (leave blank)
12
+ #
13
+ # Then either publish a GitHub Release (`vX.Y.Z`) to upload to PyPI, or run
14
+ # this workflow manually to try TestPyPI first (which needs its own publisher
15
+ # at https://test.pypi.org/manage/account/publishing/).
16
+
17
+ on:
18
+ release:
19
+ types: [published]
20
+ workflow_dispatch:
21
+ inputs:
22
+ target:
23
+ description: Where a manual run publishes
24
+ type: choice
25
+ options: [testpypi, pypi]
26
+ default: testpypi
27
+
28
+ permissions:
29
+ contents: read
30
+
31
+ jobs:
32
+ build:
33
+ name: Build sdist + wheel
34
+ runs-on: ubuntu-latest
35
+ steps:
36
+ - uses: actions/checkout@v4
37
+ - uses: astral-sh/setup-uv@v5
38
+ with:
39
+ python-version: "3.12"
40
+ - name: Build
41
+ run: uv build
42
+ - name: Validate the distribution metadata
43
+ run: uvx twine check dist/*
44
+ - uses: actions/upload-artifact@v4
45
+ with:
46
+ name: dist
47
+ path: dist/
48
+
49
+ publish:
50
+ name: Publish
51
+ needs: build
52
+ runs-on: ubuntu-latest
53
+ # OIDC token for Trusted Publishing; no secret is configured.
54
+ permissions:
55
+ id-token: write
56
+ steps:
57
+ - uses: actions/download-artifact@v4
58
+ with:
59
+ name: dist
60
+ path: dist/
61
+ - name: Publish
62
+ uses: pypa/gh-action-pypi-publish@release/v1
63
+ with:
64
+ # PyPI on a Release; TestPyPI on a manual run that asks for it.
65
+ repository-url: ${{ (github.event_name == 'workflow_dispatch' && inputs.target == 'testpypi') && 'https://test.pypi.org/legacy/' || 'https://upload.pypi.org/legacy/' }}
@@ -0,0 +1,19 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.egg-info/
5
+ dist/
6
+ build/
7
+ .pytest_cache/
8
+ .mypy_cache/
9
+ .ruff_cache/
10
+ .hypothesis/
11
+ .coverage
12
+ htmlcov/
13
+ qc.toml
14
+ profiles/
15
+ reports/
16
+ output/
17
+ state.db
18
+ *.local.*
19
+ workbench/
@@ -0,0 +1,13 @@
1
+ # Project-local RTK filters — commit this file with your repo.
2
+ # Filters here override user-global and built-in filters.
3
+ # Docs: https://github.com/rtk-ai/rtk#custom-filters
4
+ schema_version = 1
5
+
6
+ # Example: suppress build noise from a custom tool
7
+ # [filters.my-tool]
8
+ # description = "Compact my-tool output"
9
+ # match_command = "^my-tool\\s+build"
10
+ # strip_ansi = true
11
+ # strip_lines_matching = ["^\\s*$", "^Downloading", "^Installing"]
12
+ # max_lines = 30
13
+ # on_empty = "my-tool: ok"
@@ -0,0 +1,2 @@
1
+ /cache
2
+ /project.local.yml
@@ -0,0 +1,168 @@
1
+ # the name by which the project can be referenced within Serena/when chatting with the LLM.
2
+ project_name: "qc"
3
+
4
+ # list of language servers to start when using the LSP backend; choose from:
5
+ # ada al angular ansible bash
6
+ # bsl clojure cpp cpp_ccls crystal
7
+ # csharp csharp_omnisharp cue dart deno
8
+ # elixir elm erlang fortran fsharp
9
+ # gdscript gleam go groovy haskell
10
+ # haxe hlsl html java json
11
+ # julia kotlin latex lean4 lua
12
+ # luau markdown matlab msl nextflow
13
+ # nix ocaml pascal perl php
14
+ # php_phpactor php_phpantom powershell python python_basedpyright
15
+ # python_jedi python_pyrefly python_ty qml r
16
+ # rego ruby ruby_solargraph rust scala
17
+ # scss solidity svelte swift systemverilog
18
+ # terraform toml typescript typescript_vts vue
19
+ # wolfram yaml zig
20
+ # (This list may be outdated; generated with scripts/print_language_list.py;
21
+ # For the current list, see values of the LanguageServerId enum here:
22
+ # https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py)
23
+ # For some languages, there are several alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
24
+ # Note:
25
+ # - For C, use cpp
26
+ # - For JavaScript, use typescript
27
+ # - For Angular projects, use angular (subsumes typescript+html; requires `npm install` in the project root)
28
+ # - For Svelte projects, use svelte (subsumes typescript/javascript for .svelte projects; requires npm)
29
+ # - For Deno projects, use deno (serves the same .ts/.js files as typescript; requires the deno CLI on PATH)
30
+ # - For SCSS / Sass / plain CSS, use scss (some-sass-language-server handles all three)
31
+ # - For Free Pascal/Lazarus, use pascal
32
+ # Special requirements:
33
+ # Some language servers require additional setup/installations.
34
+ # See here for details: https://oraios.github.io/serena/01-about/020_programming-languages.html#language-servers
35
+ # When using multiple language servers, the first language server that supports a given file will be used for that file.
36
+ # The first language server is the default language and the respective language server will be used as a fallback.
37
+ # Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
38
+ language_servers: []
39
+
40
+ # the encoding used by text files in the project
41
+ # For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
42
+ encoding: "utf-8"
43
+
44
+ # optional shell command to run before the language backend (LSP or JetBrains) is initialised.
45
+ # the command runs in the project root directory and is only executed if the project is trusted
46
+ # (see trusted_project_path_patterns in the global configuration).
47
+ # serena waits for the command to exit: a non-zero exit code is logged as an error but does not
48
+ # abort activation. a per-project timeout (activation_command_timeout, default 180s) is the safety
49
+ # backstop for non-terminating commands; on expiry the process is killed and activation continues.
50
+ # example: activation_command: "npx nx run-many -t build"
51
+ activation_command:
52
+
53
+ # maximum time in seconds to wait for activation_command to complete before killing it (default 180s).
54
+ # must be a positive number.
55
+ activation_command_timeout: 180.0
56
+
57
+ # line ending convention to use when writing source files.
58
+ # Possible values: unset (use global setting), "lf", "crlf", or "native" (platform default)
59
+ # This does not affect Serena's own files (e.g. memories and configuration files), which always use native line endings.
60
+ line_ending:
61
+
62
+ # The language backend to use for this project.
63
+ # If not set, the global setting from serena_config.yml is used.
64
+ # Valid values: LSP, JetBrains
65
+ # Note: the backend is fixed at startup. If a project with a different backend
66
+ # is activated post-init, an error will be returned.
67
+ language_backend:
68
+
69
+ # whether to use project's .gitignore files to ignore files
70
+ ignore_all_files_in_gitignore: true
71
+
72
+ # advanced configuration option allowing to configure language server-specific options.
73
+ # Maps the language key to the options.
74
+ # The settings are considered only if the project is trusted (see global configuration to define trusted projects).
75
+ # See https://oraios.github.io/serena/02-usage/050_configuration.html#language-server-specific-settings
76
+ ls_specific_settings: {}
77
+
78
+ # list of workspace folder paths (LSP backend only).
79
+ # These folders will be used to build up Serena's symbol index.
80
+ # Paths must be within the project root and should thus be relative to the project root.
81
+ # Furthermore, the paths should not be filtered by ignore settings.
82
+ # Default setting: The entire project root folder (".") is considered.
83
+ # In (large) monorepos, this can be used to index only subfolders of the project root, e.g.
84
+ # ls_workspace_folders:
85
+ # - "./subproject1"
86
+ # - "./subproject2"
87
+ ls_workspace_folders:
88
+ - "."
89
+
90
+ # list of additional workspace folder paths for cross-package reference support.
91
+ # Paths can be absolute or relative to the project root.
92
+ # Each folder is registered as an LSP workspace folder, enabling language servers to discover
93
+ # symbols and references across package boundaries, but these folders are not indexed by Serena,
94
+ # i.e. the respective symbols will not be found using Serena's symbol search tools.
95
+ # Example:
96
+ # additional_workspace_folders:
97
+ # - ../sibling-package
98
+ # - ../shared-lib
99
+ ls_additional_workspace_folders: []
100
+
101
+ # list of additional paths to ignore in this project.
102
+ # Same syntax as gitignore, so you can use * and **.
103
+ # Important: quote patterns that start with `*`, otherwise YAML treats them as aliases.
104
+ # Example:
105
+ # ignored_paths:
106
+ # - "examples/**"
107
+ # - ".worktrees/**"
108
+ # - "**/bin/**"
109
+ # - "**/obj/**"
110
+ # Note: global ignored_paths from serena_config.yml are also applied additively.
111
+ ignored_paths: []
112
+
113
+ # whether the project is in read-only mode
114
+ # If set to true, all editing tools will be disabled and attempts to use them will result in an error
115
+ # Added on 2025-04-18
116
+ read_only: false
117
+
118
+ # list of tool names to exclude.
119
+ # This extends the existing exclusions (e.g. from the global configuration)
120
+ # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
121
+ excluded_tools: []
122
+
123
+ # list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default).
124
+ # This extends the existing inclusions (e.g. from the global configuration).
125
+ # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
126
+ included_optional_tools: []
127
+
128
+ # fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
129
+ # This cannot be combined with non-empty excluded_tools or included_optional_tools.
130
+ # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
131
+ fixed_tools: []
132
+
133
+ # list of mode names that are to be activated by default, overriding the setting in the global configuration.
134
+ # The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
135
+ # If the setting is undefined/empty, the default_modes from the global configuration (serena_config.yml) apply.
136
+ # Otherwise, this overrides the setting from the global configuration (serena_config.yml).
137
+ # Therefore, you can set this to [] if you do not want the default modes defined in the global config to apply
138
+ # for this project.
139
+ # This setting can, in turn, be overridden by CLI parameters (--mode).
140
+ # See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
141
+ default_modes:
142
+
143
+ # list of mode names to be activated additionally for this project, e.g. ["query-projects"]
144
+ # The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
145
+ # See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
146
+ added_modes:
147
+
148
+ # initial prompt for the project. It will always be given to the LLM upon activating the project
149
+ # (contrary to the memories, which are loaded on demand).
150
+ initial_prompt: ""
151
+
152
+ # time budget (seconds) per tool call for the retrieval of additional symbol information
153
+ # such as docstrings or parameter information.
154
+ # This overrides the corresponding setting in the global configuration; see the documentation there.
155
+ # If null or missing, use the setting from the global configuration.
156
+ symbol_info_budget:
157
+
158
+ # list of regex patterns which, when matched, mark a memory entry as read‑only.
159
+ # Extends the list from the global configuration, merging the two lists.
160
+ read_only_memory_patterns: []
161
+
162
+ # list of regex patterns for memories to completely ignore.
163
+ # Matching memories will not appear in list_memories or activate_project output
164
+ # and cannot be accessed via read_memory or write_memory.
165
+ # To access ignored memory files, use the read_file tool on the raw file path.
166
+ # Extends the list from the global configuration, merging the two lists.
167
+ # Example: ["_archive/.*", "_episodes/.*"]
168
+ ignored_memory_patterns: []
@@ -0,0 +1,10 @@
1
+ <!-- rtk-instructions v2 -->
2
+ # Command output
3
+
4
+ Command output here is condensed to save tokens, keeping every signal and
5
+ dropping costly noise. Treat it as the complete result: run commands
6
+ normally, and batch related commands into one call to avoid extra turns.
7
+ Truncated results state their recovery path in their own output. Re-run a
8
+ command as `rtk proxy <cmd>` only when its result is unusable: empty when
9
+ output was clearly expected, contradicting its exit code, or garbled.
10
+ <!-- /rtk-instructions -->
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent 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
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.