Skip to content

Document annotations in Server Info Modal #1124

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
mintlify wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document annotations in Server Info Modal #1124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb3cd0b
Update docs/inspector/connecting-servers.mdx
mintlify[bot] Dec 21, 2025
f21045f
Update docs/inspector/connecting-servers.mdx
mintlify[bot] Dec 21, 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
13 changes: 8 additions & 5 deletions docs/inspector/connecting-servers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ View comprehensive server details in a dedicated modal dialog:
- **Capabilities**: Tools, prompts, and resources supported by the server
- **Instructions**: Server-provided instructions for AI assistants
- **Raw capabilities**: Full JSON of server and client capabilities (with copy button)
- **OpenAI Apps SDK**: For servers using the OpenAI Apps SDK, view widget metadata in a separate tab
- **Tool metadata & annotations**: View tool-specific metadata (read/write permissions, widget configuration) and MCP annotations in a dedicated tab

### Server information

Expand All @@ -48,12 +48,15 @@ Click "Show details" to expand additional server information:
- **Instructions**: Server-provided instructions for AI assistants
- **Documentation link**: Direct link to the server's documentation if available

### OpenAI app metadata
### Tool metadata and annotations

Servers that provide OpenAI-compatible tool metadata display an OpenAI logo indicator. Expanding these servers shows two tabs:
The Server Info Modal includes a **Metadata** tab that displays tool-specific information when available:

- **Info tab**: Standard server information and capabilities
- **OpenAI Tool Metadata tab**: Detailed metadata for each tool including read/write permissions and widget configuration
- **Tool metadata**: Read/write permissions, widget configuration, and other custom metadata fields
- **Annotations**: MCP annotations attached to tools, displayed as formatted JSON
- **OpenAI Apps SDK**: For servers using the OpenAI Apps SDK, view widget metadata including output templates

This tab only appears when at least one tool has metadata or annotations defined.

## STDIO servers

Expand Down