Skip to content

Rename Toggle Endpoint to State for Clear and Explicit Status Updates #1504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Rename Toggle Endpoint to State for Clear and Explicit Status Updates #1504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
10ea45c
fix teamname in resources
rakdutta Nov 25, 2025
6615939
endpoints
rakdutta Nov 25, 2025
42dfbf4
function name change
rakdutta Nov 25, 2025
ca1b7aa
refactor
rakdutta Nov 25, 2025
14d3272
test
rakdutta Nov 25, 2025
26be758
docstring
rakdutta Nov 25, 2025
2f90e01
refactor
rakdutta Nov 25, 2025
124c3ea
refactor
rakdutta Nov 25, 2025
24fa149
docstring doctest
rakdutta Nov 25, 2025
059a6cb
md file change
rakdutta Nov 25, 2025
643fca4
rename
rakdutta Nov 25, 2025
5e34653
rename
rakdutta Nov 25, 2025
2782d50
black
rakdutta Nov 26, 2025
f647be4
teamname
rakdutta Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,7 @@ This release focuses on **Advanced OAuth Integration, Plugin Ecosystem, MCP Regi
- `GET /grpc` - List all gRPC services with team filtering
- `GET /grpc/{id}` - Get service details
- `PUT /grpc/{id}` - Update service configuration
- `POST /grpc/{id}/toggle` - Enable/disable service
- `POST /grpc/{id}/state` - Enable/disable service
- `POST /grpc/{id}/delete` - Delete service
- `POST /grpc/{id}/reflect` - Re-trigger service discovery
- `GET /grpc/{id}/methods` - List discovered methods
Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2264,9 +2264,9 @@ curl -X PUT -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \

# Toggle active status
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/tools/1/toggle?activate=false
http://localhost:4444/tools/1/state?activate=false
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/tools/1/toggle?activate=true
http://localhost:4444/tools/1/state?activate=true

# Delete tool
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/tools/1
Expand Down Expand Up @@ -2326,7 +2326,7 @@ curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \

# Toggle agent status
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/a2a/agent-id/toggle?activate=false
http://localhost:4444/a2a/agent-id/state?activate=false

# Delete agent
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
Expand Down Expand Up @@ -2376,7 +2376,7 @@ curl -X PUT -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \

# Toggle active status
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/gateways/1/toggle?activate=false
http://localhost:4444/gateways/1/state?activate=false

# Delete gateway
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/gateways/1
Expand Down Expand Up @@ -2462,7 +2462,7 @@ curl -X PUT -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \

# Toggle active
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/prompts/5/toggle?activate=false
http://localhost:4444/prompts/5/state?activate=false

# Delete prompt
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/prompts/greet
Expand Down Expand Up @@ -2520,7 +2520,7 @@ curl -X PUT -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \

# Toggle active
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/servers/UUID_OF_SERVER_1/toggle?activate=false
http://localhost:4444/servers/UUID_OF_SERVER_1/state?activate=false
```

</details>
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/architecture/plugins/gateway-hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,7 +884,7 @@ async def server_post_delete(self, payload: ServerPostOperationPayload,
| Attribute | Type | Description |
|-----------|------|-------------|
| **Hook Name** | `server_pre_status_change` | Hook identifier for configuration |
| **Execution Point** | Before server status toggle | When MCP server is about to be activated or deactivated |
| **Execution Point** | Before server status change | When MCP server is about to be activated or deactivated |
| **Purpose** | Access control, dependency validation, impact assessment | Validate status change permissions and assess operational impact |

**Payload Attributes (`ServerPreOperationPayload`)** - Same structure as other pre-hooks:
Expand Down
36 changes: 18 additions & 18 deletions docs/docs/design/images/code2flow.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/docs/development/developer-onboarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@
- Resources
- Prompts
- Gateways
- [ ] Toggle active/inactive switches
- [ ] Set active/inactive states
- [ ] JWT stored in `HttpOnly` cookie, no errors in DevTools Console

???+ check "Metrics"
Expand Down
22 changes: 11 additions & 11 deletions docs/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1714,11 +1714,11 @@ curl -X PUT -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
-d '{ "description":"Updated desc" }' \
http://localhost:4444/tools/1

# Toggle active status
# Set active status
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/tools/1/toggle?activate=false
http://localhost:4444/tools/1/state?activate=false
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/tools/1/toggle?activate=true
http://localhost:4444/tools/1/state?activate=true

# Delete tool
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/tools/1
Expand Down Expand Up @@ -1776,9 +1776,9 @@ curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
}' \
http://localhost:4444/a2a/agent-name/invoke

# Toggle agent status
# Set agent state
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/a2a/agent-id/toggle?activate=false
http://localhost:4444/a2a/agent-id/state?activate=false

# Delete agent
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
Expand Down Expand Up @@ -1826,9 +1826,9 @@ curl -X PUT -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
-d '{"description":"New description"}' \
http://localhost:4444/gateways/1

# Toggle active status
# Set active status
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/gateways/1/toggle?activate=false
http://localhost:4444/gateways/1/state?activate=false

# Delete gateway
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/gateways/1
Expand Down Expand Up @@ -1912,9 +1912,9 @@ curl -X PUT -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
-d '{"template":"Hi, {{ user }}!"}' \
http://localhost:4444/prompts/greet

# Toggle active
# Set active
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/prompts/5/toggle?activate=false
http://localhost:4444/prompts/5/state?activate=false

# Delete prompt
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/prompts/greet
Expand Down Expand Up @@ -1970,9 +1970,9 @@ curl -X PUT -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
-d '{"description":"Updated"}' \
http://localhost:4444/servers/UUID_OF_SERVER_1

# Toggle active
# Set active
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
http://localhost:4444/servers/UUID_OF_SERVER_1/toggle?activate=false
http://localhost:4444/servers/UUID_OF_SERVER_1/state?activate=false
```

</details>
Expand Down
Loading
Loading