indico-plugin-mcp 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.
- indico_plugin_mcp-0.1.0/.github/workflows/ci.yml +132 -0
- indico_plugin_mcp-0.1.0/.github/workflows/publish.yml +38 -0
- indico_plugin_mcp-0.1.0/.gitignore +10 -0
- indico_plugin_mcp-0.1.0/PKG-INFO +96 -0
- indico_plugin_mcp-0.1.0/README.md +84 -0
- indico_plugin_mcp-0.1.0/indico_mcp/__init__.py +8 -0
- indico_plugin_mcp-0.1.0/indico_mcp/core.py +420 -0
- indico_plugin_mcp-0.1.0/indico_mcp/core_abstracts.py +291 -0
- indico_plugin_mcp-0.1.0/indico_mcp/core_account.py +169 -0
- indico_plugin_mcp-0.1.0/indico_mcp/core_actions.py +12 -0
- indico_plugin_mcp-0.1.0/indico_mcp/core_materials.py +235 -0
- indico_plugin_mcp-0.1.0/indico_mcp/core_schedule.py +572 -0
- indico_plugin_mcp-0.1.0/indico_mcp/core_surveys.py +335 -0
- indico_plugin_mcp-0.1.0/indico_mcp/endpoint.py +151 -0
- indico_plugin_mcp-0.1.0/indico_mcp/event_extensions.py +727 -0
- indico_plugin_mcp-0.1.0/indico_mcp/navigation.py +41 -0
- indico_plugin_mcp-0.1.0/indico_mcp/plugin.py +57 -0
- indico_plugin_mcp-0.1.0/indico_mcp/protocol.py +121 -0
- indico_plugin_mcp-0.1.0/indico_mcp/registrations.py +680 -0
- indico_plugin_mcp-0.1.0/indico_mcp/registry.py +85 -0
- indico_plugin_mcp-0.1.0/indico_mcp/room_booking.py +283 -0
- indico_plugin_mcp-0.1.0/indico_mcp/stsa_extensions.py +506 -0
- indico_plugin_mcp-0.1.0/pyproject.toml +31 -0
- indico_plugin_mcp-0.1.0/tests/conftest.py +145 -0
- indico_plugin_mcp-0.1.0/tests/integration_support.py +25 -0
- indico_plugin_mcp-0.1.0/tests/test_core_integration.py +83 -0
- indico_plugin_mcp-0.1.0/tests/test_indico_integration.py +127 -0
- indico_plugin_mcp-0.1.0/tests/test_mcp.py +123 -0
- indico_plugin_mcp-0.1.0/tests/test_room_booking_integration.py +55 -0
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
push:
|
|
6
|
+
branches: [main]
|
|
7
|
+
workflow_dispatch:
|
|
8
|
+
workflow_call:
|
|
9
|
+
inputs:
|
|
10
|
+
release-tag:
|
|
11
|
+
description: Matching GitHub release tag for the package being verified.
|
|
12
|
+
type: string
|
|
13
|
+
default: ''
|
|
14
|
+
|
|
15
|
+
permissions:
|
|
16
|
+
contents: read
|
|
17
|
+
|
|
18
|
+
env:
|
|
19
|
+
INDICO_CONFIG: /dev/null
|
|
20
|
+
|
|
21
|
+
jobs:
|
|
22
|
+
build:
|
|
23
|
+
name: Lint and build distributions
|
|
24
|
+
runs-on: ubuntu-24.04
|
|
25
|
+
timeout-minutes: 10
|
|
26
|
+
steps:
|
|
27
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
28
|
+
with:
|
|
29
|
+
persist-credentials: false
|
|
30
|
+
|
|
31
|
+
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
|
32
|
+
with:
|
|
33
|
+
python-version: '3.12'
|
|
34
|
+
|
|
35
|
+
- name: Verify release tag
|
|
36
|
+
if: github.event_name == 'release'
|
|
37
|
+
env:
|
|
38
|
+
RELEASE_TAG: ${{ inputs.release-tag }}
|
|
39
|
+
run: |
|
|
40
|
+
python - <<'PY'
|
|
41
|
+
import os
|
|
42
|
+
import pathlib
|
|
43
|
+
import tomllib
|
|
44
|
+
|
|
45
|
+
project = tomllib.loads(pathlib.Path('pyproject.toml').read_text(encoding='utf-8'))['project']
|
|
46
|
+
expected_tag = f"v{project['version']}"
|
|
47
|
+
tag = os.environ['RELEASE_TAG']
|
|
48
|
+
if tag != expected_tag:
|
|
49
|
+
raise SystemExit(f'Expected release tag {expected_tag!r}, received {tag!r}.')
|
|
50
|
+
PY
|
|
51
|
+
|
|
52
|
+
- name: Install build tooling
|
|
53
|
+
run: python -m pip install build twine 'ruff>=0.9'
|
|
54
|
+
|
|
55
|
+
- name: Check lint
|
|
56
|
+
run: ruff check --output-format=github .
|
|
57
|
+
|
|
58
|
+
- name: Build and check sdist and wheel
|
|
59
|
+
run: |
|
|
60
|
+
python -m build
|
|
61
|
+
python -m twine check --strict dist/*
|
|
62
|
+
|
|
63
|
+
- name: Upload verified distributions
|
|
64
|
+
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
65
|
+
with:
|
|
66
|
+
name: python-distributions
|
|
67
|
+
path: dist/
|
|
68
|
+
if-no-files-found: error
|
|
69
|
+
overwrite: true
|
|
70
|
+
|
|
71
|
+
test:
|
|
72
|
+
name: Test wheel (${{ matrix.plugins }})
|
|
73
|
+
needs: build
|
|
74
|
+
runs-on: ubuntu-24.04
|
|
75
|
+
timeout-minutes: 20
|
|
76
|
+
strategy:
|
|
77
|
+
fail-fast: false
|
|
78
|
+
matrix:
|
|
79
|
+
plugins: [core, optional]
|
|
80
|
+
services:
|
|
81
|
+
postgres:
|
|
82
|
+
image: postgres:16
|
|
83
|
+
env:
|
|
84
|
+
POSTGRES_PASSWORD: postgres
|
|
85
|
+
ports:
|
|
86
|
+
- 5432/tcp
|
|
87
|
+
options: >-
|
|
88
|
+
--health-cmd "pg_isready -U postgres -d postgres"
|
|
89
|
+
--health-interval 5s
|
|
90
|
+
--health-timeout 5s
|
|
91
|
+
--health-retries 12
|
|
92
|
+
steps:
|
|
93
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
94
|
+
with:
|
|
95
|
+
persist-credentials: false
|
|
96
|
+
|
|
97
|
+
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
|
98
|
+
with:
|
|
99
|
+
python-version: '3.12'
|
|
100
|
+
cache: pip
|
|
101
|
+
cache-dependency-path: |
|
|
102
|
+
pyproject.toml
|
|
103
|
+
.github/workflows/ci.yml
|
|
104
|
+
|
|
105
|
+
- name: Install Indico system dependencies
|
|
106
|
+
run: |
|
|
107
|
+
sudo apt-get update
|
|
108
|
+
sudo apt-get install -y --no-install-recommends \
|
|
109
|
+
libpq-dev libpango-1.0-0 libpangoft2-1.0-0 libharfbuzz-subset0
|
|
110
|
+
|
|
111
|
+
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
|
|
112
|
+
with:
|
|
113
|
+
name: python-distributions
|
|
114
|
+
path: dist/
|
|
115
|
+
|
|
116
|
+
- name: Install the built wheel
|
|
117
|
+
run: python -m pip install dist/*.whl 'pytest>=8'
|
|
118
|
+
|
|
119
|
+
- name: Install supported optional plugins
|
|
120
|
+
if: matrix.plugins == 'optional'
|
|
121
|
+
run: |
|
|
122
|
+
python -m pip install \
|
|
123
|
+
'indico-plugin-stsa==0.6.2' \
|
|
124
|
+
'indico-plugin-group-registration==0.7.0' \
|
|
125
|
+
'indico-plugin-sentry==1.1.1'
|
|
126
|
+
|
|
127
|
+
- name: Run unit and PostgreSQL integration tests
|
|
128
|
+
working-directory: ${{ runner.temp }}
|
|
129
|
+
env:
|
|
130
|
+
INDICO_MCP_TEST_POSTGRES: postgresql://postgres:postgres@127.0.0.1:${{ job.services.postgres.ports['5432'] }}/postgres
|
|
131
|
+
INDICO_MCP_TEST_ALL_PLUGINS: ${{ matrix.plugins == 'optional' && '1' || '0' }}
|
|
132
|
+
run: pytest -c "$GITHUB_WORKSPACE/pyproject.toml" "$GITHUB_WORKSPACE/tests"
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
|
|
7
|
+
concurrency:
|
|
8
|
+
group: pypi-${{ github.ref }}
|
|
9
|
+
cancel-in-progress: false
|
|
10
|
+
|
|
11
|
+
permissions: {}
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
verify:
|
|
15
|
+
name: Verify tagged distributions
|
|
16
|
+
permissions:
|
|
17
|
+
contents: read
|
|
18
|
+
uses: ./.github/workflows/ci.yml
|
|
19
|
+
with:
|
|
20
|
+
release-tag: ${{ github.event.release.tag_name }}
|
|
21
|
+
|
|
22
|
+
publish:
|
|
23
|
+
name: Publish verified distributions
|
|
24
|
+
needs: verify
|
|
25
|
+
runs-on: ubuntu-24.04
|
|
26
|
+
timeout-minutes: 10
|
|
27
|
+
environment:
|
|
28
|
+
name: pypi
|
|
29
|
+
url: https://pypi.org/project/indico-plugin-mcp/
|
|
30
|
+
permissions:
|
|
31
|
+
id-token: write
|
|
32
|
+
steps:
|
|
33
|
+
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
|
|
34
|
+
with:
|
|
35
|
+
name: python-distributions
|
|
36
|
+
path: dist/
|
|
37
|
+
|
|
38
|
+
- uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: indico-plugin-mcp
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Permission-aware Model Context Protocol tools for Indico and STSA plugins
|
|
5
|
+
Requires-Python: <3.13,>=3.12.2
|
|
6
|
+
Requires-Dist: indico<3.4,>=3.3.14
|
|
7
|
+
Requires-Dist: pydantic<3,>=2.10
|
|
8
|
+
Provides-Extra: dev
|
|
9
|
+
Requires-Dist: pytest>=8; extra == 'dev'
|
|
10
|
+
Requires-Dist: ruff>=0.9; extra == 'dev'
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
|
|
13
|
+
# Indico MCP
|
|
14
|
+
|
|
15
|
+
Indico MCP gives AI agents typed tools for Indico event management and participant workflows. It runs inside Indico and acts as the account that authorized each request. Indico permissions, event protection, registration visibility, feature flags, and supported plugin rules apply to individual calls.
|
|
16
|
+
|
|
17
|
+
## Install
|
|
18
|
+
|
|
19
|
+
Install into an existing **Indico 3.3.14** environment running **Python 3.12**. The plugin has no database migrations of its own.
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
python -m pip install .
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Add `mcp` to `PLUGINS` in `indico.conf`, keep the existing entries, and restart the Indico web workers. A configuration with all supported optional plugins enabled looks like this.
|
|
26
|
+
|
|
27
|
+
```python
|
|
28
|
+
PLUGINS = {'mcp', 'stsa', 'group_registration', 'sentry'}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
The optional plugins must be installed, migrated, and configured through their own setup procedures. The adapters target the STSA directory's STSA 0.6.2, Group Registration 0.7.0, and Sentry 1.1.1. A core-only deployment uses `PLUGINS = {'mcp'}`. [Indico plugin installation documentation](https://docs.getindico.io/en/stable/installation/plugins/)
|
|
32
|
+
|
|
33
|
+
## Connect an agent
|
|
34
|
+
|
|
35
|
+
1. In the Indico account that will perform the work, open **API Tokens** and create a dedicated token. Select **Read Indico data through MCP** (`read:mcp`). Add **Perform Indico actions through MCP** (`write:mcp`) for agents that need writes. If token management is restricted, an Indico administrator can assign the scopes.
|
|
36
|
+
2. Configure the client with the **Streamable HTTP** URL `https://indico.example.org/mcp`. Include the installation prefix if Indico lives under a subpath. Supply the token through the client's secret store as `Authorization: Bearer <token>`.
|
|
37
|
+
3. Use `tools/list` to discover the available tools and `tools/call` to invoke them. Begin with the read tools to find record IDs and validate the intended changes.
|
|
38
|
+
|
|
39
|
+
Indico personal API tokens and Indico OAuth user tokens with the MCP scopes are accepted. For OAuth, provision the Indico application and obtain the token using the deployment's existing OAuth flow. Configure the client to attach the bearer credential directly. The endpoint supports request-scoped JSON responses for MCP `2026-07-28`, `2025-11-25`, `2025-06-18`, and `2025-03-26`. Browser requests that send an `Origin` must match the Indico installation origin. [Indico API token documentation](https://docs.getindico.io/en/stable/http-api/access/#api-token-authentication) · [MCP Streamable HTTP specification](https://modelcontextprotocol.io/specification/2026-07-28/basic/transports/streamable-http)
|
|
40
|
+
|
|
41
|
+
Example with a legacy-protocol client. Set `INDICO_MCP_TOKEN` in your shell before running it.
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
curl --fail-with-body https://indico.example.org/mcp \
|
|
45
|
+
-H "Authorization: Bearer $INDICO_MCP_TOKEN" \
|
|
46
|
+
-H 'Accept: application/json, text/event-stream' \
|
|
47
|
+
-H 'Content-Type: application/json' \
|
|
48
|
+
-H 'MCP-Protocol-Version: 2025-11-25' \
|
|
49
|
+
--data '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Workflows
|
|
53
|
+
|
|
54
|
+
| Area | Tools |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
| Categories and events | Browse and manage categories and events, location, scheduling, moves, locks, and event features |
|
|
57
|
+
| Programme and materials | Manage contributions and subcontributions, sessions, timetable entries, material folders, and links |
|
|
58
|
+
| Registration | Manage forms, sections, fields, and schedules. Discover field options and defaults, submit or edit a registration, respond to invitations, retrieve ticket links, moderate and withdraw registrations, check in participants, and record offline payments |
|
|
59
|
+
| Abstracts and surveys | Manage calls for abstracts, submit and update abstracts, manage surveys, and save and submit survey answers |
|
|
60
|
+
| Account | Read and update your profile, preferences, and favorites, and list your linked events |
|
|
61
|
+
| Room booking | Search rooms and availability, reserve or request rooms, view and cancel your bookings, and moderate requests when room booking is enabled |
|
|
62
|
+
| STSA (`stsa`) | Read the caller's registered events, manage STSA registration settings and profile fields, recalculate discounts, preview and send payment reminders, manage non-secret site settings, install packaged ticket templates, and inspect STSA API documentation |
|
|
63
|
+
| Group Registration (`group_registration`) | Discover group plans and disclaimers, create or join through a registration form, view and manage groups, validate membership codes, inspect balances, record offline payments, and preview and send payment reminders |
|
|
64
|
+
| Sentry (`sentry`) | Administrator status, selected settings, diagnostics and reload for the serving worker |
|
|
65
|
+
|
|
66
|
+
For self-registration, obtain the field names and options with `indico_get_registration_form` before submitting. Group Registration's plan selector and STSA's membership fields are provided by the installed plugins. These fields go through Indico's native registration validation and signals. For Wallet passes, open the link from `indico_get_registration_ticket_links` in a signed-in Indico browser. The `apple-wallet-badges` sibling repository supplies artwork and has no separate runtime. Financials, MembershipAPI, MembershipCard, and PortalWeaveSSO are separate applications. STSA's in-Indico workflows still use its configured membership integration.
|
|
67
|
+
|
|
68
|
+
### Browser and operator workflows
|
|
69
|
+
|
|
70
|
+
Open payment-provider checkout, file uploads, generated downloads, and visual editors in Indico. Use `indico_get_event_management_links` and `indico_get_site_admin_links` to find browser pages available to your account. Use native admin forms for destinations, keys, access policy, and Sentry privacy or SDK policy. Host maintenance and operator crash testing require deployment access. Abstract reviewing and judgement, paper reviewing, editing workflows, and other module actions outside the table still use the Indico UI.
|
|
71
|
+
|
|
72
|
+
## Development
|
|
73
|
+
|
|
74
|
+
```sh
|
|
75
|
+
python -m pip install -e '.[dev]'
|
|
76
|
+
python -m pytest
|
|
77
|
+
ruff check .
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Set `INDICO_MCP_TEST_POSTGRES` to a dedicated PostgreSQL test server's maintenance DSN to run the integration tests. The test account needs permission to create and drop its randomly named test database and install `unaccent` and `pg_trgm` in that database. Set `INDICO_MCP_TEST_GROUP_REGISTRATION=1` to exercise Group Registration or `INDICO_MCP_TEST_ALL_PLUGINS=1` to test all three installed optional plugins together.
|
|
81
|
+
|
|
82
|
+
## Releases
|
|
83
|
+
|
|
84
|
+
GitHub Actions builds the wheel and source distribution, checks their PyPI metadata, and tests the wheel with PostgreSQL in core-only and optional-plugin configurations. Publishing a GitHub release runs those same checks on the tagged commit before uploading the artifacts to PyPI.
|
|
85
|
+
|
|
86
|
+
The GitHub `pypi` environment accepts `v*` release tags. Add a pending GitHub Actions Trusted Publisher for the first release using the values below. For an existing PyPI project, use its Publishing settings. [GitHub environment settings](https://github.com/RobotHanzo/IndicoMCP/settings/environments) · [PyPI account publishing settings](https://pypi.org/manage/account/publishing/) · [PyPI Trusted Publishing documentation](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/)
|
|
87
|
+
|
|
88
|
+
| Field | Value |
|
|
89
|
+
| --- | --- |
|
|
90
|
+
| PyPI project | `indico-plugin-mcp` |
|
|
91
|
+
| GitHub owner | `RobotHanzo` |
|
|
92
|
+
| GitHub repository | `IndicoMCP` |
|
|
93
|
+
| Workflow | `publish.yml` |
|
|
94
|
+
| Environment | `pypi` |
|
|
95
|
+
|
|
96
|
+
Push the workflows and the package version in `pyproject.toml` to `main`. Once CI passes, publish a GitHub release from that commit using the `v<version>` tag. The first release uses `v0.1.0`. Keep the GitHub release as a draft until you are ready to publish to PyPI.
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Indico MCP
|
|
2
|
+
|
|
3
|
+
Indico MCP gives AI agents typed tools for Indico event management and participant workflows. It runs inside Indico and acts as the account that authorized each request. Indico permissions, event protection, registration visibility, feature flags, and supported plugin rules apply to individual calls.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
Install into an existing **Indico 3.3.14** environment running **Python 3.12**. The plugin has no database migrations of its own.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
python -m pip install .
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Add `mcp` to `PLUGINS` in `indico.conf`, keep the existing entries, and restart the Indico web workers. A configuration with all supported optional plugins enabled looks like this.
|
|
14
|
+
|
|
15
|
+
```python
|
|
16
|
+
PLUGINS = {'mcp', 'stsa', 'group_registration', 'sentry'}
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The optional plugins must be installed, migrated, and configured through their own setup procedures. The adapters target the STSA directory's STSA 0.6.2, Group Registration 0.7.0, and Sentry 1.1.1. A core-only deployment uses `PLUGINS = {'mcp'}`. [Indico plugin installation documentation](https://docs.getindico.io/en/stable/installation/plugins/)
|
|
20
|
+
|
|
21
|
+
## Connect an agent
|
|
22
|
+
|
|
23
|
+
1. In the Indico account that will perform the work, open **API Tokens** and create a dedicated token. Select **Read Indico data through MCP** (`read:mcp`). Add **Perform Indico actions through MCP** (`write:mcp`) for agents that need writes. If token management is restricted, an Indico administrator can assign the scopes.
|
|
24
|
+
2. Configure the client with the **Streamable HTTP** URL `https://indico.example.org/mcp`. Include the installation prefix if Indico lives under a subpath. Supply the token through the client's secret store as `Authorization: Bearer <token>`.
|
|
25
|
+
3. Use `tools/list` to discover the available tools and `tools/call` to invoke them. Begin with the read tools to find record IDs and validate the intended changes.
|
|
26
|
+
|
|
27
|
+
Indico personal API tokens and Indico OAuth user tokens with the MCP scopes are accepted. For OAuth, provision the Indico application and obtain the token using the deployment's existing OAuth flow. Configure the client to attach the bearer credential directly. The endpoint supports request-scoped JSON responses for MCP `2026-07-28`, `2025-11-25`, `2025-06-18`, and `2025-03-26`. Browser requests that send an `Origin` must match the Indico installation origin. [Indico API token documentation](https://docs.getindico.io/en/stable/http-api/access/#api-token-authentication) · [MCP Streamable HTTP specification](https://modelcontextprotocol.io/specification/2026-07-28/basic/transports/streamable-http)
|
|
28
|
+
|
|
29
|
+
Example with a legacy-protocol client. Set `INDICO_MCP_TOKEN` in your shell before running it.
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
curl --fail-with-body https://indico.example.org/mcp \
|
|
33
|
+
-H "Authorization: Bearer $INDICO_MCP_TOKEN" \
|
|
34
|
+
-H 'Accept: application/json, text/event-stream' \
|
|
35
|
+
-H 'Content-Type: application/json' \
|
|
36
|
+
-H 'MCP-Protocol-Version: 2025-11-25' \
|
|
37
|
+
--data '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Workflows
|
|
41
|
+
|
|
42
|
+
| Area | Tools |
|
|
43
|
+
| --- | --- |
|
|
44
|
+
| Categories and events | Browse and manage categories and events, location, scheduling, moves, locks, and event features |
|
|
45
|
+
| Programme and materials | Manage contributions and subcontributions, sessions, timetable entries, material folders, and links |
|
|
46
|
+
| Registration | Manage forms, sections, fields, and schedules. Discover field options and defaults, submit or edit a registration, respond to invitations, retrieve ticket links, moderate and withdraw registrations, check in participants, and record offline payments |
|
|
47
|
+
| Abstracts and surveys | Manage calls for abstracts, submit and update abstracts, manage surveys, and save and submit survey answers |
|
|
48
|
+
| Account | Read and update your profile, preferences, and favorites, and list your linked events |
|
|
49
|
+
| Room booking | Search rooms and availability, reserve or request rooms, view and cancel your bookings, and moderate requests when room booking is enabled |
|
|
50
|
+
| STSA (`stsa`) | Read the caller's registered events, manage STSA registration settings and profile fields, recalculate discounts, preview and send payment reminders, manage non-secret site settings, install packaged ticket templates, and inspect STSA API documentation |
|
|
51
|
+
| Group Registration (`group_registration`) | Discover group plans and disclaimers, create or join through a registration form, view and manage groups, validate membership codes, inspect balances, record offline payments, and preview and send payment reminders |
|
|
52
|
+
| Sentry (`sentry`) | Administrator status, selected settings, diagnostics and reload for the serving worker |
|
|
53
|
+
|
|
54
|
+
For self-registration, obtain the field names and options with `indico_get_registration_form` before submitting. Group Registration's plan selector and STSA's membership fields are provided by the installed plugins. These fields go through Indico's native registration validation and signals. For Wallet passes, open the link from `indico_get_registration_ticket_links` in a signed-in Indico browser. The `apple-wallet-badges` sibling repository supplies artwork and has no separate runtime. Financials, MembershipAPI, MembershipCard, and PortalWeaveSSO are separate applications. STSA's in-Indico workflows still use its configured membership integration.
|
|
55
|
+
|
|
56
|
+
### Browser and operator workflows
|
|
57
|
+
|
|
58
|
+
Open payment-provider checkout, file uploads, generated downloads, and visual editors in Indico. Use `indico_get_event_management_links` and `indico_get_site_admin_links` to find browser pages available to your account. Use native admin forms for destinations, keys, access policy, and Sentry privacy or SDK policy. Host maintenance and operator crash testing require deployment access. Abstract reviewing and judgement, paper reviewing, editing workflows, and other module actions outside the table still use the Indico UI.
|
|
59
|
+
|
|
60
|
+
## Development
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
python -m pip install -e '.[dev]'
|
|
64
|
+
python -m pytest
|
|
65
|
+
ruff check .
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Set `INDICO_MCP_TEST_POSTGRES` to a dedicated PostgreSQL test server's maintenance DSN to run the integration tests. The test account needs permission to create and drop its randomly named test database and install `unaccent` and `pg_trgm` in that database. Set `INDICO_MCP_TEST_GROUP_REGISTRATION=1` to exercise Group Registration or `INDICO_MCP_TEST_ALL_PLUGINS=1` to test all three installed optional plugins together.
|
|
69
|
+
|
|
70
|
+
## Releases
|
|
71
|
+
|
|
72
|
+
GitHub Actions builds the wheel and source distribution, checks their PyPI metadata, and tests the wheel with PostgreSQL in core-only and optional-plugin configurations. Publishing a GitHub release runs those same checks on the tagged commit before uploading the artifacts to PyPI.
|
|
73
|
+
|
|
74
|
+
The GitHub `pypi` environment accepts `v*` release tags. Add a pending GitHub Actions Trusted Publisher for the first release using the values below. For an existing PyPI project, use its Publishing settings. [GitHub environment settings](https://github.com/RobotHanzo/IndicoMCP/settings/environments) · [PyPI account publishing settings](https://pypi.org/manage/account/publishing/) · [PyPI Trusted Publishing documentation](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/)
|
|
75
|
+
|
|
76
|
+
| Field | Value |
|
|
77
|
+
| --- | --- |
|
|
78
|
+
| PyPI project | `indico-plugin-mcp` |
|
|
79
|
+
| GitHub owner | `RobotHanzo` |
|
|
80
|
+
| GitHub repository | `IndicoMCP` |
|
|
81
|
+
| Workflow | `publish.yml` |
|
|
82
|
+
| Environment | `pypi` |
|
|
83
|
+
|
|
84
|
+
Push the workflows and the package version in `pyproject.toml` to `main`. Once CI passes, publish a GitHub release from that commit using the `v<version>` tag. The first release uses `v0.1.0`. Keep the GitHub release as a draft until you are ready to publish to PyPI.
|