personal-projects/gitea-mcp-remote
1
0
Fork 0
generated from personal-projects/leo-claude-mktplace
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

[Sprint 01] docs: Create README and usage examples #6

New Issue
Closed
opened 2026-02-03 19:40:27 +00:00 by lmiranda · 2 comments
lmiranda commented 2026-02-03 19:40:27 +00:00
Owner
Copy Link

Document the MCP server setup, configuration, and usage.

Acceptance Criteria:

  • README.md with project overview
  • Installation instructions
  • Configuration guide (environment variables)
  • MCP server setup for Claude Desktop
  • Example usage for each tool (issues, labels, milestones)
  • Troubleshooting section
  • API reference for all tools

Include:

  • How to configure in ~/.config/claude/mcp.json
  • Example .env file structure
  • Code examples for each tool operation

Blocked By: #3, #4, #5

Document the MCP server setup, configuration, and usage. **Acceptance Criteria:** - [ ] README.md with project overview - [ ] Installation instructions - [ ] Configuration guide (environment variables) - [ ] MCP server setup for Claude Desktop - [ ] Example usage for each tool (issues, labels, milestones) - [ ] Troubleshooting section - [ ] API reference for all tools **Include:** - How to configure in ~/.config/claude/mcp.json - Example .env file structure - Code examples for each tool operation **Blocked By:** #3, #4, #5
lmiranda commented 2026-02-03 19:40:27 +00:00
Author
Owner
Copy Link

⚠️ Blocked By: #3,4,5

⚠️ **Blocked By:** #3,4,5
lmiranda commented 2026-02-03 20:31:06 +00:00
Author
Owner
Copy Link

✓ Implementation complete on branch feat/6-documentation

Completed:

  • Created comprehensive README.md with project overview
  • Added installation instructions
  • Documented configuration guide (environment variables)
  • MCP server setup instructions for Claude Desktop
  • Example usage for each tool (issues, labels, milestones)
  • Added troubleshooting section
  • Complete API reference for all tools

Documentation Sections:

  • Project overview and features
  • Installation and setup
  • MCP configuration (~/.config/claude/mcp.json)
  • Example .env file structure
  • Tool usage examples with code samples
  • API reference documentation
  • Troubleshooting common issues

Files Created:

  • README.md (comprehensive documentation)

All acceptance criteria met. Project is fully documented and ready for use.

✓ Implementation complete on branch `feat/6-documentation` ## Completed: - Created comprehensive README.md with project overview - Added installation instructions - Documented configuration guide (environment variables) - MCP server setup instructions for Claude Desktop - Example usage for each tool (issues, labels, milestones) - Added troubleshooting section - Complete API reference for all tools ## Documentation Sections: - Project overview and features - Installation and setup - MCP configuration (~/.config/claude/mcp.json) - Example .env file structure - Tool usage examples with code samples - API reference documentation - Troubleshooting common issues ## Files Created: - README.md (comprehensive documentation) All acceptance criteria met. Project is fully documented and ready for use.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Component/API
API endpoints, contracts, and integration
 Component/Auth
Authentication and authorization
 Component/Backend
Backend/server-side code
 Component/Backend
Backend service code and business logic
 Component/Core
Core application logic and architecture
 Component/Database
Database schemas, migrations, queries
 Component/Dependencies
Package dependencies and requirements
 Component/Deploy
Deployment, infrastructure, DevOps
 Component/Docker
Docker and containerization
 Component/Docs
Documentation and guides
 Component/Documentation
Documentation and guides
 Component/Frontend
User interface and client-side code
 Component/Infra
Infrastructure and system configuration
 Component/Integration
Integration and end-to-end testing
 Component/Testing
Test infrastructure and frameworks
 Priority/Critical
Critical priority - blocks other work
 Priority/High
High priority items
 Priority/Medium
Medium priority items
 Size/L
Large task (4-8 hours)
 Size/M
Medium task (2-4 hours)
 Size/S
Small task (1-2 hours)
 Tech/Docker
Docker containers and compose
 Tech/FastAPI
FastAPI backend framework
 Tech/JavaScript
JavaScript/Node.js code
 Tech/PostgreSQL
PostgreSQL database
 Tech/Python
Python language and libraries
 Tech/Redis
Redis cache and pub/sub
 Tech/Vue
Vue.js frontend framework
 Type/Build
Build system and dependencies
 Type/Documentation
Documentation updates
 Type/Feature
New feature implementation
 Type/Refactor
Code refactoring and restructuring
 Type/Setup
Initial project setup tasks
 Type/Test
Testing and quality assurance
Complexity/Complex
High uncertainty or many dependencies
 Complexity/Medium
Some unknowns or dependencies
 Complexity/Simple
Straightforward, well-understood
 Effort/L
3-5 days
 Effort/M
1-2 days
 Effort/S
2-4 hours
 Effort/XL
> 1 week
 Effort/XS
< 2 hours
 Priority/Critical
Immediate attention required
 Priority/High
Important, needs attention soon
 Priority/Low
Nice to have, can wait
 Priority/Medium
Normal priority
 Type/Bug
Something isn't working
 Type/Chore
Maintenance tasks
 Type/Documentation
Documentation improvements
 Type/Feature
New feature or request
 Type/Refactor
Code refactoring without changing behavior
 Type/Test
Testing related
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
lmiranda
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: personal-projects/gitea-mcp-remote#6
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?