-
Notifications
You must be signed in to change notification settings - Fork 151
docs: Add comprehensive service tokens documentation with custom attributes #8235
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.
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
base: main
Are you sure you want to change the base?
Conversation
- Create new service-tokens.md page in /manage section covering: - Overview and use cases for service tokens - Creating tokens with roles and custom attributes - Organization and project-level role management - Custom attributes for fine-grained access control - Managing and editing service tokens - Using attributes with security policies - Issuing ephemeral tokens - Best practices and troubleshooting - Update /integrate/custom-api.md: - Document custom attributes for service tokens - Add examples of using attributes with security policies - Link to comprehensive service tokens documentation - Remove outdated information about admin-only access - Update /integrate/embedding.md: - Improve service token creation examples with roles - Update references to new service tokens documentation - Update /build/metrics-view/security.md: - Add service token custom attributes example - Link to service tokens documentation - Update /manage/index.md: - Add service tokens to Access Control section Related to PR #7480 which added custom attributes support 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Create new user-tokens.md page in /manage section covering: - Overview and use cases for user (personal access) tokens - Comparison with service tokens - Creating tokens via CLI and UI (AI tab) - Managing tokens: listing, revoking, rotation - Using tokens with custom APIs, MCP, CLI, and scripts - Token permissions and security policies - Detailed use cases (local dev, MCP, scripts) - Best practices for security and lifecycle management - Troubleshooting guide - Comprehensive comparison table for when to use user vs service tokens - Update /manage/index.md: - Add user tokens to Access Control section - Position before service tokens (ordered by typical usage) - Update /integrate/custom-api.md: - Expand user tokens section with creation examples - Add expiration example - Link to comprehensive user tokens documentation - Note about automatic revocation - Update /explore/mcp.md: - Clarify token creation via UI vs CLI - Add tip box linking to user tokens documentation - Update /guides/setting-up-mcp.md: - Clarify user token terminology - Add tip box linking to user tokens documentation Related to PR #7359 which added user access token APIs 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
|
@pjain1 and @grahamplata as youve both been making some changes to our tokens, can you checkout the doc contents? Overall looks good to me, and references the correct pages :) thanks! |
|
You're absolutely right. Once PR #8197 is merged and clients can retrieve tokens in the background, the manual token creation sections in the MCP documentation should be simplified or removed. The current approach of exposing PATs to users is indeed not ideal from a security perspective, and the upcoming changes will provide a much cleaner integration experience. |
|
Based on the comment, the "Via the UI" section in the user tokens documentation can be removed. The commenter indicates that after PR #8197 is merged, MCP clients like Claude and ChatGPT will retrieve tokens automatically in the background, eliminating the need for users to manually create and see tokens for MCP integration. docs/docs/manage/user-tokens.md |
|
You're right. The UI-based token creation section ("Via the UI") in the user tokens documentation is primarily for MCP setup and should be moved to the MCP documentation. The user tokens doc should focus on CLI-based creation and general PAT management, with just a brief mention that PATs are used by MCP clients for authentication. This would avoid duplication and keep the documentation more focused on their respective purposes. |
|
thanks for the quick feedback @pjain1 , made requseted changed. @ericpgreen2 , good to go? |
Documentation Review - From Claude CodeOverall AssessmentDocumentation Quality: 9/10 This is excellent documentation work! The structure is sound, the level of detail is appropriate, and the writing is clear and professional. The cross-references create a cohesive documentation ecosystem. Information Architecture ✅Keeping tokens in
Recommendation: Enhance discoverability by adding a prominent callout at the top of :::tip Authentication Required
Most Rill integrations require authentication tokens. Before you begin:
- **[User Tokens](/manage/user-tokens)** - For local development and personal use
- **[Service Tokens](/manage/service-tokens)** - For production systems and APIs
- **[Roles and Permissions](/manage/roles-permissions)** - Understanding access control
:::DRY Concerns - Needs Attention 🔴There's significant duplication that will create maintenance burden, especially in Problem: High Duplication
Recommended Pattern: "Minimal Inline, Maximum Reference"For each integration doc, include:
Specific Fix for
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here are a few comments from me.
Particularly, I'm worried about the repetition of the token docs within the Custom API page. See Claude's review above. Is Claude's review clear? If not I can elaborate.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not to be addressed in this PR... but I'm wondering if this page is too redundant to the main MCP docs.
Summary
This PR adds comprehensive documentation for service tokens, including the new custom attributes feature added in PR #7480.
What's New
New Documentation Page -
/manage/service-tokens.mdA comprehensive guide covering:
Updated Pages
/integrate/custom-api.md/integrate/embedding.md/build/metrics-view/security.md/manage/index.mdKey Features Documented
Custom Attributes
rill service create my-service \ --project-role viewer \ --attributes '{"customer_id":"acme-corp","region":"us-west"}'Using Attributes in Security Policies
Role Management
Token Management
Documentation Organization
The service tokens documentation follows the principle of separation of concerns:
/manage/service-tokens.md- Management: How to create, configure, and manage service tokens/integrate/custom-api.md- Integration: How to use service tokens in applicationsThis makes it easier for users to find what they need:
/manage/integrateRelated
🤖 Generated with Claude Code